Skip to content

Commit 7c4b50b

Browse files
author
jpfinne
committed
Doc only for JavaClientCodegen and SpringCodeGen
1 parent 8023714 commit 7c4b50b

28 files changed

Lines changed: 127 additions & 147 deletions

docs/generators/java-camel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
112112
|useHttpServiceProxyFactoryInterfacesConfigurator|Generate HttpInterfacesAbstractConfigurator based on an HttpServiceProxyFactory instance (as opposed to a WebClient instance, when disabled) for generating Spring HTTP interfaces.| |false|
113113
|useJackson3|Set it in order to use jackson 3 dependencies (only allowed when `useSpringBoot4` is set and incompatible with `openApiNullable`).| |false|
114114
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
115-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
115+
|useJspecify|Use Jspecify for null checks| |false|
116116
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |true|
117117
|useOptional|Use Optional container for optional parameters| |false|
118118
|useResponseEntity|Use the `ResponseEntity` type to wrap return values of generated API methods. If disabled, method are annotated using a `@ResponseStatus` annotation, which has the status of the first response declared in the Api definition| |true|

docs/generators/java-dubbo.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8181
|title|API title name| |null|
8282
|useGenericResponse|Use generic response wrapper| |false|
8383
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
84-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
8584
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
8685
|useTags|use tags for creating interface and controller classnames| |true|
8786
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|

docs/generators/java-helidon-client.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
6666
|sourceFolder|source folder for generated code| |src/main/java|
6767
|testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
6868
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
69-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
7069
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
7170
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
7271
|x-helidon-groupBy|Selects how to group operations into APIs|<dl><dt>**tags**</dt><dd>Use the 'tags' settings on each operation</dd><dt>**first-path-segment**</dt><dd>Use the first segment of the path</dd></dl>|tags|

docs/generators/java-helidon-server.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
6969
|useAbstractClass|Whether to generate abstract classes for REST API instead of interfaces.| |false|
7070
|useBeanValidation|Use Bean Validation| |false|
7171
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
72-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
7372
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
7473
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
7574
|x-helidon-groupBy|Selects how to group operations into APIs|<dl><dt>**tags**</dt><dd>Use the 'tags' settings on each operation</dd><dt>**first-path-segment**</dt><dd>Use the first segment of the path</dd></dl>|tags|

docs/generators/java-inflector.md

Lines changed: 57 additions & 58 deletions
Large diffs are not rendered by default.

docs/generators/java-micronaut-client.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8989
|title|Client service name| |null|
9090
|useBeanValidation|Use BeanValidation API annotations| |true|
9191
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
92-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
9392
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
9493
|useOptional|Use Optional container for optional parameters| |false|
9594
|visitable|Generate visitor for subtypes with a discriminator| |false|

docs/generators/java-micronaut-server.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
8888
|useAuth|Whether to import authorization and to annotate controller methods accordingly| |true|
8989
|useBeanValidation|Use BeanValidation API annotations| |true|
9090
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
91-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
9291
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
9392
|useOptional|Use Optional container for optional parameters| |false|
9493
|visitable|Generate visitor for subtypes with a discriminator| |false|

docs/generators/java-microprofile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
9999
|useGzipFeature|Send gzip-encoded requests| |false|
100100
|useJackson3|Use Jackson 3 instead of Jackson 2. Supported for 'native' library (requires Java 17+) and for Spring 'resttemplate', 'webclient', and 'restclient' libraries (require useSpringBoot4=true). Incompatible with 'openApiNullable'.| |false|
101101
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
102-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
102+
|useJspecify|Use Jspecify for null checks. Ony supported for [native, webclient, restclient, resttemplate]| |false|
103103
|useOneOfDiscriminatorLookup|Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped. Only jersey2, jersey3, native, okhttp-gson support this option.| |false|
104104
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
105105
|usePlayWS|Use Play! Async HTTP client (Play WS API)| |false|

docs/generators/java-msf4j.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
7676
|title|a title describing the application| |OpenAPI Server|
7777
|useBeanValidation|Use BeanValidation API annotations| |true|
7878
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
79-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
8079
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
8180
|useTags|use tags for creating interface and controller classnames| |false|
8281
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|

docs/generators/java-pkmst.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
7777
|testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
7878
|title|server title name or client service name| |null|
7979
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
80-
|useJspecify|Use Jspecify for null checks. Ony available for Spring, RestClient, WebClient| |false|
8180
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
8281
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
8382
|zipkinUri|Zipkin URI| |null|

0 commit comments

Comments
 (0)