Skip to content

Commit 3950cd5

Browse files
committed
1385 Generate constants for path in spring boot @RequestMapping
1 parent 1b352c2 commit 3950cd5

File tree

258 files changed

+2357
-1529
lines changed

Some content is hidden

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

258 files changed

+2357
-1529
lines changed

docs/generators/aspnetcore.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2020
| ------ | ----------- | ------ | ------- |
2121
|aspnetCoreVersion|ASP.NET Core version: 6.0, 5.0, 3.1, 3.0, 2.2, 2.1, 2.0 (deprecated)|<dl><dt>**2.0**</dt><dd>ASP.NET Core 2.0</dd><dt>**2.1**</dt><dd>ASP.NET Core 2.1</dd><dt>**2.2**</dt><dd>ASP.NET Core 2.2</dd><dt>**3.0**</dt><dd>ASP.NET Core 3.0</dd><dt>**3.1**</dt><dd>ASP.NET Core 3.1</dd><dt>**5.0**</dt><dd>ASP.NET Core 5.0</dd><dt>**6.0**</dt><dd>ASP.NET Core 6.0</dd><dt>**7.0**</dt><dd>ASP.NET Core 7.0</dd><dt>**8.0**</dt><dd>ASP.NET Core 8.0</dd></dl>|8.0|
2222
|buildTarget|Target to build an application or library|<dl><dt>**program**</dt><dd>Generate code for a standalone server</dd><dt>**library**</dt><dd>Generate code for a server abstract class library</dd></dl>|program|
23-
|centralizedPackageVersionManagement|Option to control the usage of centralized package version management. https://devblogs.microsoft.com/nuget/introducing-central-package-management/#disabling-central-package-management|<dl><dt>**optout**</dt><dd>Opt out of centralized package version management. Set this if you have a Directory.Packages.pros file but want this project to ignore it.</dd><dt>**default**</dt><dd>Property in project won't be used</dd><dt>**enable**</dt><dd>Centralized package version management will be used</dd></dl>|null|
2423
|classModifier|Class Modifier for controller classes: Empty string or abstract.| ||
2524
|compatibilityVersion|ASP.Net Core CompatibilityVersion| |Version_2_2|
2625
|enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|

docs/generators/csharp.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2828
|equatable|Overrides Equals and GetHashCode methods.| |false|
2929
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
3030
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
31-
|library|HTTP library template (sub-template) to use|<dl><dt>**generichost**</dt><dd>HttpClient, Generic Host integration, and System.Text.Json (https://docs.microsoft.com/en-us/dotnet/core/extensions/generic-host)</dd><dt>**httpclient**</dt><dd>HttpClient and Newtonsoft (https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient) (Experimental. Subject to breaking changes without notice.)</dd><dt>**unityWebRequest**</dt><dd>UnityWebRequest (...) (Experimental. Subject to breaking changes without notice.)</dd><dt>**restsharp**</dt><dd>RestSharp (https://github.com/restsharp/RestSharp)</dd></dl>|generichost|
31+
|library|HTTP library template (sub-template) to use|<dl><dt>**generichost**</dt><dd>HttpClient with Generic Host dependency injection (https://docs.microsoft.com/en-us/dotnet/core/extensions/generic-host) (Experimental. Subject to breaking changes without notice.)</dd><dt>**httpclient**</dt><dd>HttpClient (https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient) (Experimental. Subject to breaking changes without notice.)</dd><dt>**unityWebRequest**</dt><dd>UnityWebRequest (...) (Experimental. Subject to breaking changes without notice.)</dd><dt>**restsharp**</dt><dd>RestSharp (https://github.com/restsharp/RestSharp)</dd></dl>|restsharp|
3232
|licenseId|The identifier of the license| |null|
3333
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
3434
|modelPropertySorting|One of legacy, alphabetical, default.| |default|
@@ -44,16 +44,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl
4444
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
4545
|packageTags|Tags to identify the package| |null|
4646
|packageVersion|C# package version.| |1.0.0|
47+
|releaseNote|Release note, default to 'Minor update'.| |Minor update|
4748
|returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false|
4849
|sourceFolder|source folder for generated code| |src|
49-
|targetFramework|The target .NET framework version. To target multiple frameworks, use `;` as the separator, e.g. `netstandard2.1;netcoreapp3.1`|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0</dd><dt>**netstandard2.1**</dt><dd>.NET Standard 2.1</dd><dt>**net47**</dt><dd>.NET Framework 4.7</dd><dt>**net48**</dt><dd>.NET Framework 4.8</dd><dt>**net8.0**</dt><dd>.NET 8.0 (End of Support 10 November 2026)</dd><dt>**net9.0**</dt><dd>.NET 9.0 (End of Support 12 May 2026)</dd></dl>|net9.0|
50+
|targetFramework|The target .NET framework version. To target multiple frameworks, use `;` as the separator, e.g. `netstandard2.1;netcoreapp3.1`|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0</dd><dt>**netstandard2.1**</dt><dd>.NET Standard 2.1</dd><dt>**net47**</dt><dd>.NET Framework 4.7</dd><dt>**net48**</dt><dd>.NET Framework 4.8</dd><dt>**net6.0**</dt><dd>.NET 6.0 (End of Support 12 November 2024)</dd><dt>**net7.0**</dt><dd>.NET 7.0</dd><dt>**net8.0**</dt><dd>.NET 8.0</dd></dl>|net8.0|
5051
|useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
5152
|useDateTimeForDate|Use DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)| |false|
5253
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
53-
|useIntForTimeout|Use int for Timeout (fall back to v7.9.0 templates). This option (for restsharp only) will be deprecated so please migrated to TimeSpan instead.| |false|
5454
|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.| |false|
5555
|useSourceGeneration|Use source generation where available (only `generichost` library supports this option).| |false|
56-
|useVirtualForHooks|Generate code that exposes public virtual hooks on ApiClient to customize low-level HTTP requests (only `restsharp`. `httpclient` libraries support this option).| |false|
5756
|validatable|Generates self-validatable models.| |true|
5857
|zeroBasedEnums|Enumerations with string values will start from 0 when true, 1 when false. If not set, enumerations with string values will start from 0 if the first value is 'unknown', case insensitive.| |null|
5958

docs/generators/elixir.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,19 @@ These options may be applied as additional-properties (cli) or configOptions (pl
4545
## LANGUAGE PRIMITIVES
4646

4747
<ul class="column-ul">
48-
<li>Date.t</li>
49-
<li>DateTime.t</li>
50-
<li>String.t</li>
48+
<li>AnyType</li>
49+
<li>Atom</li>
50+
<li>Boolean</li>
51+
<li>Decimal</li>
52+
<li>Float</li>
53+
<li>Integer</li>
54+
<li>List</li>
55+
<li>Map</li>
56+
<li>PID</li>
57+
<li>String</li>
58+
<li>Tuple</li>
5159
<li>any()</li>
52-
<li>binary()</li>
53-
<li>boolean()</li>
54-
<li>float()</li>
55-
<li>integer()</li>
56-
<li>list()</li>
5760
<li>map()</li>
58-
<li>nil</li>
59-
<li>number()</li>
6061
</ul>
6162

6263
## RESERVED WORDS
@@ -188,7 +189,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
188189
|BasicAuth|✓|OAS2,OAS3
189190
|ApiKey|✗|OAS2,OAS3
190191
|OpenIDConnect|✗|OAS3
191-
|BearerToken||OAS3
192+
|BearerToken||OAS3
192193
|OAuth2_Implicit|✓|OAS2,OAS3
193194
|OAuth2_Password|✗|OAS2,OAS3
194195
|OAuth2_ClientCredentials|✗|OAS2,OAS3

docs/generators/groovy.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3838
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
3939
|discriminatorCaseSensitive|Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client| |true|
4040
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
41-
|enumPropertyNaming|Naming convention for enum properties: 'MACRO_CASE', 'legacy' and 'original'| |MACRO_CASE|
4241
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
4342
|generateBuilders|Whether to generate builders for models| |false|
4443
|generateConstructorWithAllArgs|whether to generate a constructor for all arguments| |false|
@@ -52,7 +51,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5251
|licenseName|The name of the license| |Unlicense|
5352
|licenseUrl|The URL of the license| |http://unlicense.org|
5453
|modelPackage|package for generated models| |org.openapitools.model|
55-
|openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|
54+
|openApiNullable|Enable OpenAPI Jackson Nullable library| |true|
5655
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
5756
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
5857
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|

docs/generators/java-camel.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,9 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5454
|discriminatorCaseSensitive|Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client| |true|
5555
|documentationProvider|Select the OpenAPI documentation provider.|<dl><dt>**none**</dt><dd>Do not publish an OpenAPI specification.</dd><dt>**source**</dt><dd>Publish the original input OpenAPI specification.</dd><dt>**springfox**</dt><dd>Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using SpringFox 2.x. Deprecated (for removal); use springdoc instead.</dd><dt>**springdoc**</dt><dd>Generate an OpenAPI 3 specification using SpringDoc.</dd></dl>|springdoc|
5656
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
57-
|enumPropertyNaming|Naming convention for enum properties: 'MACRO_CASE', 'legacy' and 'original'| |MACRO_CASE|
5857
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
5958
|generateBuilders|Whether to generate builders for models| |false|
6059
|generateConstructorWithAllArgs|whether to generate a constructor for all arguments| |false|
61-
|generateGenericResponseEntity|Use a generic type for the `ResponseEntity` wrapping return values of generated API methods. If enabled, method are generated with return type ResponseEntity&lt;?&gt;| |false|
6260
|generatedConstructorWithRequiredArgs|Whether to generate constructors with required args for models| |true|
6361
|groupId|groupId in generated pom.xml| |org.openapitools|
6462
|hateoas|Use Spring HATEOAS library to allow adding HATEOAS links| |false|
@@ -73,8 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
7371
|licenseName|The name of the license| |Unlicense|
7472
|licenseUrl|The URL of the license| |http://unlicense.org|
7573
|modelPackage|package for generated models| |org.openapitools.model|
76-
|openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|
77-
|optionalAcceptNullable|Use `ofNullable` instead of just `of` to accept null values when using Optional.| |true|
74+
|openApiNullable|Enable OpenAPI Jackson Nullable library| |true|
7875
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
7976
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
8077
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
@@ -100,15 +97,12 @@ These options may be applied as additional-properties (cli) or configOptions (pl
10097
|unhandledException|Declare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring `@ControllerAdvice` directives).| |false|
10198
|useBeanValidation|Use BeanValidation API annotations| |true|
10299
|useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
103-
|useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
104100
|useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
105101
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
106102
|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|
107103
|useOptional|Use Optional container for optional parameters| |false|
108104
|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|
109-
|useSealed|Whether to generate sealed model interfaces and classes| |false|
110105
|useSpringBoot3|Generate code and provide dependencies for use with Spring Boot 3.x. (Use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.| |false|
111-
|useSpringBuiltInValidation|Disable `@Validated` at the class level when using built-in validation.| |false|
112106
|useSpringController|Annotate the generated API as a Spring Controller| |false|
113107
|useSwaggerUI|Open the OpenApi specification in swagger-ui. Will also import and configure needed dependencies| |true|
114108
|useTags|use tags for creating interface and controller classnames| |false|
@@ -128,7 +122,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
128122
|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
129123
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
130124
|x-operation-extra-annotation|List of custom annotations to be added to operation|OPERATION|null
131-
|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
125+
|x-spring-paginated|Add org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parameters|OPERATION|false
132126
|x-version-param|Marker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/false|OPERATION_PARAMETER|null
133127
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
134128

docs/generators/java-helidon-client.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3636
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
3737
|discriminatorCaseSensitive|Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client| |true|
3838
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
39-
|enumPropertyNaming|Naming convention for enum properties: 'MACRO_CASE', 'legacy' and 'original'| |MACRO_CASE|
4039
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
4140
|fullProject|If set to true, it will generate all files; if set to false, it will only generate API files. If unspecified, the behavior depends on whether a project exists or not: if it does not, same as true; if it does, same as false. Note that test files are never overwritten.| ||
4241
|generateBuilders|Whether to generate builders for models| |false|
@@ -53,7 +52,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5352
|licenseName|The name of the license| |Unlicense|
5453
|licenseUrl|The URL of the license| |http://unlicense.org|
5554
|modelPackage|package for generated models| |org.openapitools.client.model|
56-
|openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|
55+
|openApiNullable|Enable OpenAPI Jackson Nullable library| |true|
5756
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
5857
|rootJavaEEPackage|Root package name for Java EE| |Helidon 2.x and earlier: javax; Helidon 3.x and later: jakarta|
5958
|serializableModel|boolean - toggle &quot;implements Serializable&quot; for generated models| |false|

0 commit comments

Comments
 (0)