Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit 5971cdc

Browse files
spacetherspacether
authored
Kotlin: schema docs improvements (#435)
* Updates lowercase java types to uppercase kotlin types * kotlin samples regen * Samples regen with correct class/data class descriptions * Updates jvmToolchain * Removes caches from kotlin test run in ci * Turns nodaemon on in ci * Removes info from gradle test invocation
1 parent bad5584 commit 5971cdc

File tree

241 files changed

+5789
-6058
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+5789
-6058
lines changed

‎.circleci/config.yml

-7
Original file line numberDiff line numberDiff line change
@@ -143,15 +143,8 @@ jobs:
143143
CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
144144
CIRCLE_TEST_REPORTS: /tmp/circleci-test-results
145145
steps:
146-
- restore_cache:
147-
keys:
148-
- kotlinClientGradleCache
149146
- command_build_and_test:
150147
jobId: "testKotlinClientSamples"
151-
- save_cache:
152-
key: kotlinClientGradleCache
153-
paths:
154-
- ~/build
155148
workflows:
156149
version: 2
157150
build:

‎.circleci/testKotlinClientSamples.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
(cd samples/client/3_0_3_unit_test/kotlin && gradle wrapper && ./gradlew cleanTest test -info)
2-
(cd samples/client/3_1_0_unit_test/kotlin && gradle wrapper && ./gradlew cleanTest test -info)
1+
(cd samples/client/3_0_3_unit_test/kotlin && gradle wrapper && ./gradlew cleanTest test --no-daemon)
2+
(cd samples/client/3_1_0_unit_test/kotlin && gradle wrapper && ./gradlew cleanTest test --no-daemon)

‎samples/client/3_0_3_unit_test/kotlin/build.gradle.kts

+2-4
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,8 @@ group = "org.openapijsonschematools"
2121
version = "0.0.1"
2222
description = "OpenAPI Kotlin"
2323

24-
java {
25-
toolchain {
26-
languageVersion.set(JavaLanguageVersion.of(17))
27-
}
24+
kotlin {
25+
jvmToolchain(17)
2826
}
2927

3028
tasks.wrapper {

‎samples/client/3_0_3_unit_test/kotlin/docs/components/schemas/AdditionalpropertiesAllowsASchemaWhichShouldValidate.md

+36-40
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,29 @@ A class that contains necessary nested
1313
| Modifier and Type | Class and Description |
1414
| ----------------- | ---------------------- |
1515
| sealed interface | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidate1Boxed](#additionalpropertiesallowsaschemawhichshouldvalidate1boxed)<br> sealed interface for validated payloads |
16-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidate1BoxedMap](#additionalpropertiesallowsaschemawhichshouldvalidate1boxedmap)<br> boxed class to store validated Map payloads |
17-
| static class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidate1](#additionalpropertiesallowsaschemawhichshouldvalidate1)<br> schema class |
18-
| static class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMapBuilder](#additionalpropertiesallowsaschemawhichshouldvalidatemapbuilder)<br> builder for Map payloads |
19-
| static class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMap](#additionalpropertiesallowsaschemawhichshouldvalidatemap)<br> output class for Map payloads |
16+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidate1BoxedMap](#additionalpropertiesallowsaschemawhichshouldvalidate1boxedmap)<br> boxed class to store validated Map payloads |
17+
| class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidate1](#additionalpropertiesallowsaschemawhichshouldvalidate1)<br> schema class |
18+
| class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMapBuilder](#additionalpropertiesallowsaschemawhichshouldvalidatemapbuilder)<br> builder for Map payloads |
19+
| class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMap](#additionalpropertiesallowsaschemawhichshouldvalidatemap)<br> output class for Map payloads |
2020
| sealed interface | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxed](#barboxed)<br> sealed interface for validated payloads |
21-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedVoid](#barboxedvoid)<br> boxed class to store validated null payloads |
22-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedBoolean](#barboxedboolean)<br> boxed class to store validated boolean payloads |
23-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedNumber](#barboxednumber)<br> boxed class to store validated Number payloads |
24-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedString](#barboxedstring)<br> boxed class to store validated String payloads |
25-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedList](#barboxedlist)<br> boxed class to store validated List payloads |
26-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedMap](#barboxedmap)<br> boxed class to store validated Map payloads |
27-
| static class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.Bar](#bar)<br> schema class |
21+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedVoid](#barboxedvoid)<br> boxed class to store validated null payloads |
22+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedBoolean](#barboxedboolean)<br> boxed class to store validated boolean payloads |
23+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedNumber](#barboxednumber)<br> boxed class to store validated Number payloads |
24+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedString](#barboxedstring)<br> boxed class to store validated String payloads |
25+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedList](#barboxedlist)<br> boxed class to store validated List payloads |
26+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.BarBoxedMap](#barboxedmap)<br> boxed class to store validated Map payloads |
27+
| class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.Bar](#bar)<br> schema class |
2828
| sealed interface | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxed](#fooboxed)<br> sealed interface for validated payloads |
29-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedVoid](#fooboxedvoid)<br> boxed class to store validated null payloads |
30-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedBoolean](#fooboxedboolean)<br> boxed class to store validated boolean payloads |
31-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedNumber](#fooboxednumber)<br> boxed class to store validated Number payloads |
32-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedString](#fooboxedstring)<br> boxed class to store validated String payloads |
33-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedList](#fooboxedlist)<br> boxed class to store validated List payloads |
34-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedMap](#fooboxedmap)<br> boxed class to store validated Map payloads |
35-
| static class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.Foo](#foo)<br> schema class |
29+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedVoid](#fooboxedvoid)<br> boxed class to store validated null payloads |
30+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedBoolean](#fooboxedboolean)<br> boxed class to store validated boolean payloads |
31+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedNumber](#fooboxednumber)<br> boxed class to store validated Number payloads |
32+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedString](#fooboxedstring)<br> boxed class to store validated String payloads |
33+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedList](#fooboxedlist)<br> boxed class to store validated List payloads |
34+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.FooBoxedMap](#fooboxedmap)<br> boxed class to store validated Map payloads |
35+
| class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.Foo](#foo)<br> schema class |
3636
| sealed interface | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalPropertiesBoxed](#additionalpropertiesboxed)<br> sealed interface for validated payloads |
37-
| record | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalPropertiesBoxedBoolean](#additionalpropertiesboxedboolean)<br> boxed class to store validated boolean payloads |
38-
| static class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalProperties](#additionalproperties)<br> schema class |
37+
| data class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalPropertiesBoxedBoolean](#additionalpropertiesboxedboolean)<br> boxed class to store validated boolean payloads |
38+
| class | [AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalProperties](#additionalproperties)<br> schema class |
3939

4040
## AdditionalpropertiesAllowsASchemaWhichShouldValidate1Boxed
4141
sealed interface AdditionalpropertiesAllowsASchemaWhichShouldValidate1Boxed<br>
@@ -69,29 +69,25 @@ A schema class that validates payloads
6969

7070
### Code Sample
7171
```
72-
import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
73-
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
74-
import org.openapijsonschematools.client.exceptions.ValidationException;
75-
import org.openapijsonschematools.client.schemas.validation.MapUtils;
76-
import org.openapijsonschematools.client.schemas.validation.FrozenList;
77-
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
78-
import org.openapijsonschematools.client.components.schemas.AdditionalpropertiesAllowsASchemaWhichShouldValidate;
72+
import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags
73+
import org.openapijsonschematools.client.configurations.SchemaConfiguration
74+
import org.openapijsonschematools.client.exceptions.ValidationException
75+
import org.openapijsonschematools.client.schemas.validation.MapUtils
76+
import org.openapijsonschematools.client.schemas.validation.FrozenList
77+
import org.openapijsonschematools.client.schemas.validation.FrozenMap
78+
import org.openapijsonschematools.client.components.schemas.AdditionalpropertiesAllowsASchemaWhichShouldValidate
7979
80-
import java.util.Arrays;
81-
import java.util.List;
82-
import java.util.AbstractMap;
83-
84-
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
80+
val configuration = SchemaConfiguration(JsonSchemaKeywordFlags.Builder().build())
8581
8682
// Map validation
87-
AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMap validatedPayload =
83+
val validatedPayload: AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMap =
8884
AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidate1.validate(
89-
new AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMapBuilder()
85+
AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsASchemaWhichShouldValidateMapBuilder()
9086
.additionalProperty("someAdditionalProperty", true)
9187
9288
.build(),
9389
configuration
94-
);
90+
)
9591
```
9692

9793
### Field Summary
@@ -104,8 +100,8 @@ AdditionalpropertiesAllowsASchemaWhichShouldValidate.AdditionalpropertiesAllowsA
104100
### Method Summary
105101
| Modifier and Type | Method and Description |
106102
| ----------------- | ---------------------- |
107-
| [AdditionalpropertiesAllowsASchemaWhichShouldValidateMap](#additionalpropertiesallowsaschemawhichshouldvalidatemap) | validate(arg: [Map&lt;?, ?&gt;](#additionalpropertiesallowsaschemawhichshouldvalidatemapbuilder), configuration: SchemaConfiguration) |
108-
| [AdditionalpropertiesAllowsASchemaWhichShouldValidate1BoxedMap](#additionalpropertiesallowsaschemawhichshouldvalidate1boxedmap) | validateAndBox([Map&lt;?, ?&gt;](#additionalpropertiesallowsaschemawhichshouldvalidatemapbuilder), configuration: SchemaConfiguration) |
103+
| [AdditionalpropertiesAllowsASchemaWhichShouldValidateMap](#additionalpropertiesallowsaschemawhichshouldvalidatemap) | validate(arg: [Map&lt;*, *&gt;](#additionalpropertiesallowsaschemawhichshouldvalidatemapbuilder), configuration: SchemaConfiguration) |
104+
| [AdditionalpropertiesAllowsASchemaWhichShouldValidate1BoxedMap](#additionalpropertiesallowsaschemawhichshouldvalidate1boxedmap) | validateAndBox([Map&lt;*, *&gt;](#additionalpropertiesallowsaschemawhichshouldvalidatemapbuilder), configuration: SchemaConfiguration) |
109105
| [AdditionalpropertiesAllowsASchemaWhichShouldValidate1Boxed](#additionalpropertiesallowsaschemawhichshouldvalidate1boxed) | validateAndBox(Any?, configuration: SchemaConfiguration) |
110106
| Any? | validate(arg: Any?, configuration: SchemaConfiguration) |
111107

@@ -191,7 +187,7 @@ data class that stores validated null payloads, sealed permits implementation
191187
data class BarBoxedBoolean<br>
192188
implements [BarBoxed](#barboxed)
193189

194-
record that stores validated boolean payloads, sealed permits implementation
190+
data class that stores validated boolean payloads, sealed permits implementation
195191

196192
### Constructor Summary
197193
| Constructor and Description |
@@ -316,7 +312,7 @@ data class that stores validated null payloads, sealed permits implementation
316312
data class FooBoxedBoolean<br>
317313
implements [FooBoxed](#fooboxed)
318314

319-
record that stores validated boolean payloads, sealed permits implementation
315+
data class that stores validated boolean payloads, sealed permits implementation
320316

321317
### Constructor Summary
322318
| Constructor and Description |
@@ -419,7 +415,7 @@ sealed interface that stores validated payloads using boxed classes
419415
data class AdditionalPropertiesBoxedBoolean<br>
420416
implements [AdditionalPropertiesBoxed](#additionalpropertiesboxed)
421417

422-
record that stores validated boolean payloads, sealed permits implementation
418+
data class that stores validated boolean payloads, sealed permits implementation
423419

424420
### Constructor Summary
425421
| Constructor and Description |

0 commit comments

Comments
 (0)