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

Commit bd0884d

Browse files
spacetherspacether
committed
Docs regen
1 parent bdb8644 commit bd0884d

3 files changed

Lines changed: 40 additions & 27 deletions

File tree

‎docs/generators/java.md‎

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,14 @@ title: Documentation for the java generator
1212
| generator language | Java | |
1313
| generator language version | 17 | |
1414
| generator default templating engine | handlebars | |
15-
| helpTxt | Generates a Java client library<br /><br />Features in this generator:<br />- v3.0.0 - [v3.1.0](#schema-feature) OpenAPI Specification support<br />- Very thorough documentation generated in the style of javadocs<br />- Input types constrained for a Schema in SomeSchema.validate<br /> - validate method can accept arbitrary List/Map/null/int/long/double/float/String json data<br />- Immutable List output classes generated and returned by validate for List&lt;?&gt; input<br />- Immutable Map output classes generated and returned by validate for Map&lt;?, ?&gt; input<br />- Strictly typed list input can be instantiated in client code using generated ListBuilders<br />- Strictly typed map input can be instantiated in client code using generated MapBuilders<br /> - Sequential map builders are generated ensuring that required properties are set before build is invoked. Looks like:<br /> - `new MapBuilder().requiredA("a").requiredB("b").build()`<br /> - `new MapBuilder().requiredA("a").requiredB("b").optionalProp("c").additionalProperty("someAddProp", "d").build()`<br />- Run time type checking and validation when<br /> - validating schema payloads<br /> - instantiating List output class (validation run)<br /> - instantiating Map output class (validation run)<br /> - Note: if needed, validation of json schema keywords can be deactivated via a SchemaConfiguration class<br />- Enums classes are generated and may be input into Schema.validate or the List/MapBuilder add/setter methods<br />- The [Checker-Framework's](https://github.com/typetools/checker-framework) NullnessChecker and @Nullable annotations are used in the java client<br /> - ensuring that null pointer exceptions will not happen<br />- Invalid (in java) property names supported like `class`, `1var`, `hi-there` etc in<br /> - component schema names<br /> - schema property names (a fallback setter is written in the MapBuilder)<br />- Generated interfaces are largely consistent with the python code<br />- Openapi spec inline schemas supported at any depth in any location<br />- Format support for: int32, int64, float, double, date, datetime, uuid<br />- Payload values are not coerced when validated, so a date/date-time value can pass other validations that describe the payload only as type string<br />- enum types are generated for enums of type string/integer/number/boolean/null<br />- String transmission of numbers supported with type: string, format: number | |
15+
| helpMsg | Generates a Java client library<br /><br />Features in this generator:<br />- v3.0.0 - [v3.1.0](#schema-feature) OpenAPI Specification support<br />- Very thorough documentation generated in the style of javadocs<br />- Input types constrained for a Schema in SomeSchema.validate<br /> - validate method can accept arbitrary List/Map/null/int/long/double/float/String json data<br />- Immutable List output classes generated and returned by validate for List&lt;?&gt; input<br />- Immutable Map output classes generated and returned by validate for Map&lt;?, ?&gt; input<br />- Strictly typed list input can be instantiated in client code using generated ListBuilders<br />- Strictly typed map input can be instantiated in client code using generated MapBuilders<br /> - Sequential map builders are generated ensuring that required properties are set before build is invoked. Looks like:<br /> - `new MapBuilder().requiredA("a").requiredB("b").build()`<br /> - `new MapBuilder().requiredA("a").requiredB("b").optionalProp("c").additionalProperty("someAddProp", "d").build()`<br />- Run time type checking and validation when<br /> - validating schema payloads<br /> - instantiating List output class (validation run)<br /> - instantiating Map output class (validation run)<br /> - Note: if needed, validation of json schema keywords can be deactivated via a SchemaConfiguration class<br />- Enums classes are generated and may be input into Schema.validate or the List/MapBuilder add/setter methods<br />- The [Checker-Framework's](https://github.com/typetools/checker-framework) NullnessChecker and @Nullable annotations are used in the java client<br /> - ensuring that null pointer exceptions will not happen<br />- Invalid (in java) property names supported like `class`, `1var`, `hi-there` etc in<br /> - component schema names<br /> - schema property names (a fallback setter is written in the MapBuilder)<br />- Generated interfaces are largely consistent with the python code<br />- Openapi spec inline schemas supported at any depth in any location<br />- Format support for: int32, int64, float, double, date, datetime, uuid<br />- Payload values are not coerced when validated, so a date/date-time value can pass other validations that describe the payload only as type string<br />- enum types are generated for enums of type string/integer/number/boolean/null<br />- String transmission of numbers supported with type: string, format: number | |
1616

1717
## CONFIG OPTIONS
1818
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
1919

2020
| Option | Description | Values | Default |
2121
| ------ | ----------- | ------ | ------- |
2222
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
23-
|apiPackage|package for generated api classes| |apis|
2423
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
2524
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-client|
2625
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapi-json-schema-tools/openapi-json-schema-generator|
@@ -30,7 +29,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3029
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
3130
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapijsonschematools.org|
3231
|groupId|groupId in generated pom.xml| |org.openapijsonschematools|
33-
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
3432
|invokerPackage|root package for generated code| |org.openapijsonschematools.client|
3533
|licenseName|The name of the license| |Unlicense|
3634
|licenseUrl|The URL of the license| |http://unlicense.org|
@@ -192,26 +190,26 @@ These options may be applied as additional-properties (cli) or configOptions (pl
192190
| Name | Supported | Defined By |
193191
| ---- | --------- | ---------- |
194192
|Custom|✗|OAS2,OAS3
195-
|Int32|✓|OAS2,OAS3
196-
|Int64|✓|OAS2,OAS3
197-
|Integer|✓|OAS2,OAS3
198-
|Float|✓|OAS2,OAS3
199-
|Double|✓|OAS2,OAS3
200-
|Number|✓|OAS2,OAS3
201-
|String|✓|OAS2,OAS3
193+
|Int32|✗|OAS2,OAS3
194+
|Int64|✗|OAS2,OAS3
195+
|Integer|✗|OAS2,OAS3
196+
|Float|✗|OAS2,OAS3
197+
|Double|✗|OAS2,OAS3
198+
|Number|✗|OAS2,OAS3
199+
|String|✗|OAS2,OAS3
202200
|Byte|✗|OAS2,OAS3
203201
|Binary|✗|OAS2,OAS3
204-
|Boolean|✓|OAS2,OAS3
205-
|Date|✓|OAS2,OAS3
206-
|DateTime|✓|OAS2,OAS3
202+
|Boolean|✗|OAS2,OAS3
203+
|Date|✗|OAS2,OAS3
204+
|DateTime|✗|OAS2,OAS3
207205
|Password|✗|OAS2,OAS3
208206
|File|✗|OAS2
209-
|Uuid|✓|OAS2,OAS3
210-
|Array|✓|OAS2,OAS3
211-
|Null|✓|OAS3
212-
|AnyType|✓|OAS2,OAS3
213-
|Object|✓|OAS2,OAS3
214-
|Enum|✓|OAS2,OAS3
207+
|Uuid|✗|OAS2,OAS3
208+
|Array|✗|OAS2,OAS3
209+
|Null|✗|OAS3
210+
|AnyType|✗|OAS2,OAS3
211+
|Object|✗|OAS2,OAS3
212+
|Enum|✗|OAS2,OAS3
215213

216214
### Documentation Feature
217215
| Name | Supported | Defined By |
@@ -233,7 +231,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
233231
### Global Feature
234232
| Name | Supported | Defined By |
235233
| ---- | --------- | ---------- |
236-
|Info|✓|OAS2,OAS3
234+
|Info|✗|OAS2,OAS3
237235
|Servers|✓|OAS3
238236
|Paths|✓|OAS2,OAS3
239237
|Webhooks|✗|OAS3
@@ -334,7 +332,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
334332
### Wire Format Feature
335333
| Name | Supported | Defined By |
336334
| ---- | --------- | ---------- |
337-
|JSON|✓|OAS2,OAS3
335+
|JSON|✗|OAS2,OAS3
338336
|XML|✗|OAS2,OAS3
339337
|PROTOBUF|✗|ToolingExtension
340338
|Custom|✗|OAS2,OAS3

‎docs/generators/python.md‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: Documentation for the python generator
1212
| generator language | Python | |
1313
| generator language version | >=3.8 | |
1414
| generator default templating engine | handlebars | |
15-
| helpTxt | Generates a Python client library<br /><br />Features in this generator:<br />- type hints on endpoints and model creation<br />- model parameter names use the spec defined keys and cases<br />- robust composition (oneOf/anyOf/allOf/not) where payload data is stored in one instance only<br />- endpoint parameter names use the spec defined keys and cases<br />- inline schemas are supported at any location including composition<br />- multiple content types supported in request body and response bodies<br />- run time type checking + json schema validation<br />- json schema keyword validation may be selectively disabled with SchemaConfiguration<br />- enums of type string/integer/boolean typed using typing.Literal<br />- mypy static type checking run on generated sample<br />- Sending/receiving decimals as strings supported with type:string format: number -> DecimalSchema<br />- Sending/receiving uuids as strings supported with type:string format: uuid -> UUIDSchema<br />- quicker load time for python modules (a single endpoint can be imported and used without loading others)<br />- composed schemas with type constraints supported (type:object + oneOf/anyOf/allOf)<br />- schemas are not coerced/cast. For example string + date are both stored as string, and there is a date accessor | |
15+
| helpMsg | Generates a Python client library<br /><br />Features in this generator:<br />- type hints on endpoints and model creation<br />- model parameter names use the spec defined keys and cases<br />- robust composition (oneOf/anyOf/allOf/not) where payload data is stored in one instance only<br />- endpoint parameter names use the spec defined keys and cases<br />- inline schemas are supported at any location including composition<br />- multiple content types supported in request body and response bodies<br />- run time type checking + json schema validation<br />- json schema keyword validation may be selectively disabled with SchemaConfiguration<br />- enums of type string/integer/boolean typed using typing.Literal<br />- mypy static type checking run on generated sample<br />- Sending/receiving decimals as strings supported with type:string format: number -> DecimalSchema<br />- Sending/receiving uuids as strings supported with type:string format: uuid -> UUIDSchema<br />- quicker load time for python modules (a single endpoint can be imported and used without loading others)<br />- composed schemas with type constraints supported (type:object + oneOf/anyOf/allOf)<br />- schemas are not coerced/cast. For example string + date are both stored as string, and there is a date accessor | |
1616

1717
## CONFIG OPTIONS
1818
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
@@ -22,12 +22,10 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2222
|generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false|
2323
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
2424
|nonCompliantUseDiscriminatorIfCompositionFails|When true, If the payload fails to validate against composed schemas (allOf/anyOf/oneOf/not) and a discriminator is present, then ignore the composition validation errors and attempt to use the discriminator to validate the payload.<br />Note: setting this to true makes the generated client not comply with json schema because it ignores composition validation errors. Please consider making your schemas more restrictive rather than setting this to true. You can do that by:<ul><li>defining the propertyName as an enum with only one value in the schemas that are in your discriminator map</li><li>setting additionalProperties: false in your schemas</li></ul>|<dl><dt>**true**</dt><dd>If composition fails and a discriminator exists, the composition errors will be ignored and validation will be attempted with the discriminator</dd><dt>**false**</dt><dd>Composition validation must succeed. Discriminator validation must succeed.</dd></dl>|false|
25-
|packageName|python package name (convention: snake_case).| |openapi_client|
2625
|packageUrl|python package URL.| |null|
2726
|packageVersion|python package version.| |1.0.0|
2827
|projectName|python project name in setup.py (e.g. petstore-api).| |null|
2928
|recursionLimit|Set the recursion limit. If not set, use the system default value.| |null|
30-
|templatingEngine|template engine|<dl><dt>**handlebars**</dt><dd>handlebars templating engine</dd></dl>|handlebars|
3129
|useNose|use the nose test framework| |false|
3230

3331
## SUPPORTED VENDOR EXTENSIONS
@@ -54,33 +52,38 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5452
## LANGUAGE PRIMITIVES
5553

5654
<ul class="column-ul">
55+
<li>None</li>
5756
<li>bool</li>
5857
<li>bytes</li>
5958
<li>date</li>
6059
<li>datetime</li>
6160
<li>dict</li>
6261
<li>file</li>
63-
<li>file_type</li>
6462
<li>float</li>
6563
<li>int</li>
6664
<li>list</li>
67-
<li>none_type</li>
6865
<li>object</li>
6966
<li>str</li>
7067
</ul>
7168

7269
## RESERVED WORDS
7370

7471
<ul class="column-ul">
72+
<li>@property</li>
73+
<li>all_params</li>
7574
<li>and</li>
7675
<li>as</li>
7776
<li>assert</li>
7877
<li>async</li>
78+
<li>auth_settings</li>
7979
<li>await</li>
80+
<li>body_params</li>
8081
<li>bool</li>
8182
<li>break</li>
8283
<li>class</li>
8384
<li>continue</li>
85+
<li>datetime</li>
86+
<li>decimal</li>
8487
<li>def</li>
8588
<li>del</li>
8689
<li>dict</li>
@@ -92,30 +95,43 @@ These options may be applied as additional-properties (cli) or configOptions (pl
9295
<li>finally</li>
9396
<li>float</li>
9497
<li>for</li>
98+
<li>form_params</li>
9599
<li>from</li>
100+
<li>functools</li>
96101
<li>global</li>
102+
<li>header_params</li>
97103
<li>if</li>
98104
<li>immutabledict</li>
99105
<li>import</li>
100106
<li>in</li>
101107
<li>int</li>
108+
<li>io</li>
102109
<li>is</li>
103110
<li>lambda</li>
104111
<li>list</li>
112+
<li>local_var_files</li>
105113
<li>none</li>
106114
<li>nonlocal</li>
107115
<li>not</li>
108116
<li>or</li>
109117
<li>pass</li>
118+
<li>path_params</li>
110119
<li>print</li>
111120
<li>property</li>
121+
<li>query_params</li>
112122
<li>raise</li>
123+
<li>re</li>
124+
<li>resource_path</li>
113125
<li>return</li>
126+
<li>schemas</li>
114127
<li>self</li>
115128
<li>str</li>
116129
<li>true</li>
117130
<li>try</li>
118131
<li>tuple</li>
132+
<li>typing</li>
133+
<li>typing_extensions</li>
134+
<li>uuid</li>
119135
<li>while</li>
120136
<li>with</li>
121137
<li>yield</li>

‎src/main/java/org/openapijsonschematools/codegen/generators/JavaClientGenerator.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ public JavaClientGenerator(GeneratorSettings generatorSettings, WorkflowSettings
9999
supportsInheritance = true;
100100

101101

102-
cliOptions.add(new CliOption(CodegenConstants.API_PACKAGE, CodegenConstants.API_PACKAGE_DESC));
103102
cliOptions.add(new CliOption(CodegenConstants.INVOKER_PACKAGE, CodegenConstants.INVOKER_PACKAGE_DESC).defaultValue(this.getInvokerPackage()));
104103
cliOptions.add(new CliOption(CodegenConstants.GROUP_ID, CodegenConstants.GROUP_ID_DESC).defaultValue(this.getGroupId()));
105104
cliOptions.add(new CliOption(CodegenConstants.ARTIFACT_ID, CodegenConstants.ARTIFACT_ID_DESC).defaultValue(this.getArtifactId()));

0 commit comments

Comments
 (0)