From 26b19d336fdc7e7d6543647eda02211acb9ed765 Mon Sep 17 00:00:00 2001 From: frantuma Date: Mon, 6 Jan 2025 14:07:39 +0100 Subject: [PATCH 1/3] allow specifying openAPI version (e.g. 3.0.4, 3.1.1) --- .../annotations/ExternalDocumentation.java | 4 +- .../v3/oas/annotations/OpenAPIDefinition.java | 2 +- .../swagger/v3/oas/annotations/Operation.java | 2 +- .../swagger/v3/oas/annotations/Parameter.java | 2 +- .../oas/annotations/callbacks/Callback.java | 2 +- .../oas/annotations/extensions/Extension.java | 2 +- .../v3/oas/annotations/headers/Header.java | 2 +- .../v3/oas/annotations/info/Contact.java | 2 +- .../swagger/v3/oas/annotations/info/Info.java | 2 +- .../v3/oas/annotations/info/License.java | 2 +- .../v3/oas/annotations/links/Link.java | 2 +- .../v3/oas/annotations/media/ArraySchema.java | 2 +- .../v3/oas/annotations/media/Content.java | 2 +- .../media/DiscriminatorMapping.java | 2 +- .../v3/oas/annotations/media/Encoding.java | 2 +- .../oas/annotations/media/ExampleObject.java | 2 +- .../v3/oas/annotations/media/Schema.java | 2 +- .../annotations/parameters/RequestBody.java | 2 +- .../annotations/responses/ApiResponse.java | 2 +- .../security/SecurityRequirement.java | 2 +- .../annotations/security/SecurityScheme.java | 6 +- .../v3/oas/annotations/servers/Server.java | 2 +- .../swagger/v3/oas/annotations/tags/Tag.java | 2 +- modules/swagger-gradle-plugin/README.md | 6 +- .../v3/plugins/gradle/tasks/ResolveTask.java | 18 ++++++ .../integration/GenericOpenApiContext.java | 28 ++++++++++ .../oas/integration/SwaggerConfiguration.java | 25 +++++++++ .../integration/api/OpenAPIConfiguration.java | 5 ++ .../java/io/swagger/v3/jaxrs2/Reader.java | 4 ++ .../ServletConfigContextUtils.java | 6 ++ .../ServletOpenApiConfigurationLoader.java | 4 ++ .../v3/jaxrs2/integration/SwaggerLoader.java | 19 +++++++ .../java/io/swagger/v3/jaxrs2/ReaderTest.java | 21 +++++++ modules/swagger-maven-plugin/README.md | 56 ++++++++++--------- .../swagger/v3/plugin/maven/SwaggerMojo.java | 10 ++++ .../io/swagger/v3/oas/models/Components.java | 2 +- .../v3/oas/models/ExternalDocumentation.java | 2 +- .../io/swagger/v3/oas/models/OpenAPI.java | 2 +- .../io/swagger/v3/oas/models/Operation.java | 2 +- .../io/swagger/v3/oas/models/PathItem.java | 2 +- .../java/io/swagger/v3/oas/models/Paths.java | 2 +- .../v3/oas/models/callbacks/Callback.java | 2 +- .../v3/oas/models/examples/Example.java | 2 +- .../swagger/v3/oas/models/headers/Header.java | 2 +- .../swagger/v3/oas/models/info/Contact.java | 2 +- .../io/swagger/v3/oas/models/info/Info.java | 2 +- .../swagger/v3/oas/models/info/License.java | 2 +- .../io/swagger/v3/oas/models/links/Link.java | 2 +- .../swagger/v3/oas/models/media/Content.java | 2 +- .../swagger/v3/oas/models/media/Encoding.java | 2 +- .../v3/oas/models/media/EncodingProperty.java | 2 +- .../v3/oas/models/media/MediaType.java | 2 +- .../swagger/v3/oas/models/media/Schema.java | 2 +- .../io/swagger/v3/oas/models/media/XML.java | 2 +- .../v3/oas/models/parameters/Parameter.java | 2 +- .../v3/oas/models/parameters/RequestBody.java | 2 +- .../v3/oas/models/responses/ApiResponse.java | 2 +- .../v3/oas/models/responses/ApiResponses.java | 2 +- .../v3/oas/models/security/OAuthFlow.java | 2 +- .../v3/oas/models/security/OAuthFlows.java | 2 +- .../v3/oas/models/security/Scopes.java | 2 +- .../models/security/SecurityRequirement.java | 2 +- .../oas/models/security/SecurityScheme.java | 2 +- .../swagger/v3/oas/models/servers/Server.java | 2 +- .../v3/oas/models/servers/ServerVariable.java | 2 +- .../oas/models/servers/ServerVariables.java | 2 +- .../io/swagger/v3/oas/models/tags/Tag.java | 2 +- 67 files changed, 231 insertions(+), 87 deletions(-) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java index f99ac8b8fc..14f0df4ba8 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java @@ -13,12 +13,12 @@ /** * The annotation may be used at method level or as field of {@link Operation} to add a reference to an external - * resource for extended documentation of an Operation (OpenAPI specification). + * resource for extended documentation of an Operation (OpenAPI specification). *

It may also be used to add external documentation to {@link io.swagger.v3.oas.annotations.tags.Tag}, * {@link io.swagger.v3.oas.annotations.headers.Header} or {@link io.swagger.v3.oas.annotations.media.Schema}, * or as field of {@link OpenAPIDefinition}.

* - * @see External Documentation (OpenAPI specification) + * @see External Documentation (OpenAPI specification) * @see OpenAPIDefinition **/ @Target({METHOD, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java index e795a32555..c32fdd8776 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java @@ -19,7 +19,7 @@ * The annotation that may be used to populate OpenAPI Object fields info, tags, servers, security and externalDocs * If more than one class is annotated with {@link OpenAPIDefinition}, with the same fields defined, behaviour is inconsistent. * - * @see OpenAPI (OpenAPI specification) + * @see OpenAPI (OpenAPI specification) */ @Target({TYPE, PACKAGE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java index 0b84450ffc..e957df72ee 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java @@ -38,7 +38,7 @@ *
  • hidden: @{@link Hidden}
    • * * - * @see Operation (OpenAPI specification) + * @see Operation (OpenAPI specification) **/ @Target({METHOD, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java index 3cfd741f79..fb59366bdd 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java @@ -30,7 +30,7 @@ * *

    For method parameters bound to the request body, see {@link io.swagger.v3.oas.annotations.parameters.RequestBody}

    * - * @see Parameter (OpenAPI specification) + * @see Parameter (OpenAPI specification) * @see io.swagger.v3.oas.annotations.parameters.RequestBody * @see Operation * @see Schema diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java index 32768c9282..6b128c9357 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java @@ -18,7 +18,7 @@ /** * The annotation may be used at method level to add one ore more callbacks to the operation definition. * - * @see Callback (OpenAPI specification) + * @see Callback (OpenAPI specification) **/ @Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java index 4604013c6f..92d2d03acb 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java @@ -14,7 +14,7 @@ /** * An optionally named list of extension properties. * - * @see Specification extensions (OpenAPI specification) + * @see Specification extensions (OpenAPI specification) */ @Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java index b9bc2031c3..7dc88e55d9 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java @@ -15,7 +15,7 @@ * encoding by defining it as field {@link io.swagger.v3.oas.annotations.responses.ApiResponse#headers()} or {@link io.swagger.v3.oas.annotations.media.Content#encoding()}. *

    Please note that request headers are defined as Header {@link io.swagger.v3.oas.annotations.Parameter}.

    * - * @see Header (OpenAPI specification) + * @see Header (OpenAPI specification) * @see io.swagger.v3.oas.annotations.responses.ApiResponse * @see io.swagger.v3.oas.annotations.Parameter * @see io.swagger.v3.oas.annotations.media.Encoding diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java index 5d4435bdad..723e1d80c2 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java @@ -9,7 +9,7 @@ /** * The annotation may be used in {@link Info#contact()} to define a contact for the OpenAPI spec. * - * @see Contact (OpenAPI specification) + * @see Contact (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see Info **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java index 4fd9abb706..0c8b2a4490 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java @@ -12,7 +12,7 @@ /** * The annotation may be used in {@link io.swagger.v3.oas.annotations.OpenAPIDefinition#info()} to populate the Info section of the OpenAPI document. * - * @see Info (OpenAPI specification) + * @see Info (OpenAPI specification) * @see Info (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java index 8beb07362e..5faed40537 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java @@ -10,7 +10,7 @@ /** * The annotation may be used in {@link Info#license()} to define a license for the OpenAPI spec. * - * @see License (OpenAPI 3.0 pecification) + * @see License (OpenAPI 3.0 pecification) * @see License (OpenAPI 3.1 specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see Info diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java index f5696974c5..0551576797 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java @@ -12,7 +12,7 @@ /** * The annotation may be applied in {@link io.swagger.v3.oas.annotations.responses.ApiResponse#links()} to add OpenAPI links to a response. * - * @see Link (OpenAPI specification) + * @see Link (OpenAPI specification) * @see io.swagger.v3.oas.annotations.responses.ApiResponse **/ @Target({ElementType.ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java index baabd6ecbe..8b43a9ff0b 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java @@ -25,7 +25,7 @@ *

    The annotation {@link Schema} shall be used for non array elements; {@link ArraySchema} and {@link Schema} cannot * coexist

    * - * @see Schema (OpenAPI specification) + * @see Schema (OpenAPI specification) * @see Schema (OpenAPI specification) * @see Schema **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java index f4532f9c4a..1fe4a03f84 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java @@ -16,7 +16,7 @@ * JAX-RS annotations, element type and context as input to resolve the annotated element into an OpenAPI schema * definition for such element.

    * - * @see Example (OpenAPI specification) + * @see Example (OpenAPI specification) * @see Schema * @see io.swagger.v3.oas.annotations.Parameter * @see io.swagger.v3.oas.annotations.responses.ApiResponse diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java index 42b875a642..69c94bc42e 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java @@ -15,7 +15,7 @@ * *

    Use {@link Schema#discriminatorProperty()} to define a discriminator property.

    * - * @see Discriminator (OpenAPI specification) + * @see Discriminator (OpenAPI specification) * @see Discriminator (OpenAPI specification) * @see Schema **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java index 5c1c55a0cc..6e29335b34 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java @@ -12,7 +12,7 @@ * The annotation may be used to add encoding details to the definition of a parameter, request or response content, * by defining it as field {@link Content#encoding()} * - * @see Encoding (OpenAPI specification) + * @see Encoding (OpenAPI specification) * @see Content **/ @Target({}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java index b8a5dd3d5c..66e4df5a18 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java @@ -12,7 +12,7 @@ * The annotation may be used to add one or more examples to the definition of a parameter, request or response content, * by defining it as field {@link io.swagger.v3.oas.annotations.Parameter#examples()} or {@link Content#examples()} * - * @see Example (OpenAPI specification) + * @see Example (OpenAPI specification) **/ @Target({ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java index 0ba732c6e5..df2e512671 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java @@ -30,7 +30,7 @@ *

    The annotation {@link ArraySchema} shall be used for array elements; {@link ArraySchema} and {@link Schema} cannot * coexist

    * - * @see Schema (OpenAPI specification) + * @see Schema (OpenAPI specification) * @see Schema (OpenAPI specification) * @see ArraySchema **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java index 3fd98ca409..b306a61120 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java @@ -16,7 +16,7 @@ * The annotation may be used on a method parameter to define it as the Request Body of the operation, and/or to define * additional properties for such request body. * - * @see Request Body (OpenAPI specification) + * @see Request Body (OpenAPI specification) * @see io.swagger.v3.oas.annotations.Parameter * @see Content **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java index b704266b06..da021f6990 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java @@ -22,7 +22,7 @@ *

    swagger-jaxrs2 reader engine considers this annotation along with method return type and context as input to * resolve the OpenAPI Operation responses.

    * - * @see Response (OpenAPI specification) + * @see Response (OpenAPI specification) * @see io.swagger.v3.oas.annotations.Operation **/ @Target({METHOD, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java index 320b10c3d3..23c6d1dd08 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java @@ -15,7 +15,7 @@ * single operation (when applied at method level) or for all operations of a class (when applied at class level). *

    It can also be used in {@link io.swagger.v3.oas.annotations.OpenAPIDefinition#security()} to define spec level security.

    * - * @see Security Requirement (OpenAPI specification) + * @see Security Requirement (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see io.swagger.v3.oas.annotations.Operation **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java index ceceb184dc..bf424451ef 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java @@ -17,8 +17,8 @@ * The annotation may be used at class level (also on multiple classes) to add securitySchemes to spec * components section. * - * @see Security Scheme (OpenAPI specification) - * @see Components (OpenAPI specification) + * @see Security Scheme (OpenAPI specification) + * @see Components (OpenAPI specification) **/ @Target({TYPE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) @@ -48,7 +48,7 @@ /** * The name of the header or query parameter to be used. Applies to apiKey type. - * Maps to "name" property of Security Scheme (OpenAPI specification) + * Maps to "name" property of Security Scheme (OpenAPI specification) * * @return String paramName **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java index 8d3a83e065..8aedc2028a 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java @@ -17,7 +17,7 @@ * single operation (when applied at method level) or for all operations of a class (when applied at class level). *

    It can also be used in {@link io.swagger.v3.oas.annotations.OpenAPIDefinition#servers()} to define spec level servers.

    * - * @see Server (OpenAPI specification) + * @see Server (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see io.swagger.v3.oas.annotations.Operation **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java index 73719b18ed..46c378fb98 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java @@ -21,7 +21,7 @@ * if additional fields are also defined, like description or externalDocs, the Tag will also be added to openAPI.tags * field

    * - * @see Tag (OpenAPI specification) + * @see Tag (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition **/ @Target({METHOD, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-gradle-plugin/README.md b/modules/swagger-gradle-plugin/README.md index 24abb86a8c..5129d6a599 100644 --- a/modules/swagger-gradle-plugin/README.md +++ b/modules/swagger-gradle-plugin/README.md @@ -99,12 +99,13 @@ Parameter | Description | Required | Default `defaultResponseCode`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false| `openapi31`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | `schemaResolution`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| DEFAULT | +`openAPIVersion`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| `3.0.1/3.1.0` | **Note** parameter `openApiFile` corresponds to [config](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties) openAPI. It points to a location of a file in YAML or JSON format representing the input spec that will be merged with the resolved spec. Typically used to add Info section, or any other meta data. An example of such file: ```yaml -openapi: 3.0.1 +openapi: 3.0.4 info: version: '1.0' title: Swagger Pet Sample App Config File @@ -127,4 +128,5 @@ Since version 2.2.12, `openapi31` parameter is available, if set to true the res Since version 2.1.15, `skipResolveAppPath` parameter is available, allowing to skip resolving of Application Path from annotation Since version 2.2.17, `defaultResponseCode` parameter is available, allowing to set the code used when resolving responses with no http status code annotation Since version 2.2.17, `defaultResponseCode` parameter is available, allowing to set the code used when resolving responses with no http status code annotation -Since version 2.2.24, `schemaResolution` parameter is available, allowing to specify how object schemas and object properties within schemas are resolved for OAS 3.0 specification \ No newline at end of file +Since version 2.2.24, `schemaResolution` parameter is available, allowing to specify how object schemas and object properties within schemas are resolved for OAS 3.0 specification +Since version 2.2.28, `openAPIVersion` parameter is available, allowing to specify the version of the OpenAPI specification to be used for the resolved spec. \ No newline at end of file diff --git a/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java b/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java index a3acfa4cd7..07f812b564 100644 --- a/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java +++ b/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java @@ -128,6 +128,11 @@ public enum Format {JSON, YAML, JSONANDYAML} @Input @Optional public final Property schemaResolution = getProject().getObjects().property(String.class); + + @Input + @Optional + private String openAPIVersion; + @Input @Optional public final Property defaultResponseCode = getProject().getObjects().property(String.class); @@ -398,6 +403,14 @@ public void setSchemaResolution(String schemaResolution) { this.schemaResolution.set(schemaResolution); } + public Property getOpenAPIVersion() { + return openAPIVersion; + } + + public void setOpenAPIVersion(String openAPIVersion) { + this.openAPIVersion.set(openAPIVersion); + } + @TaskAction public void resolve() throws GradleException { if (skip.getOrElse(false)) { @@ -528,6 +541,11 @@ public void resolve() throws GradleException { method = swaggerLoaderClass.getDeclaredMethod("setSchemaResolution", String.class); method.invoke(swaggerLoader, schemaResolution.get()); } + if (openAPIVersion.isPresent()) { + method = swaggerLoaderClass.getDeclaredMethod("setOpenAPIVersion", String.class); + method.invoke(swaggerLoader, openAPIVersion.get()); + } + method = swaggerLoaderClass.getDeclaredMethod("resolve"); Map specs = (Map) method.invoke(swaggerLoader); diff --git a/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/GenericOpenApiContext.java b/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/GenericOpenApiContext.java index 27a4216144..b28d063ce0 100644 --- a/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/GenericOpenApiContext.java +++ b/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/GenericOpenApiContext.java @@ -78,6 +78,8 @@ public class GenericOpenApiContext implements O private Schema.SchemaResolution schemaResolution; + private String openAPIVersion; + public long getCacheTTL() { return cacheTTL; } @@ -354,6 +356,28 @@ public T schemaResolution(Schema.SchemaResolution schemaResolution) { return (T) this; } + /** + * @since 2.2.28 + */ + public String getOpenAPIVersion() { + return openAPIVersion; + } + + /** + * @since 2.2.28 + */ + public void setOpenAPIVersion(String openAPIVersion) { + this.openAPIVersion = openAPIVersion; + } + + /** + * @since 2.2.28 + */ + public T openAPIVersion(String openAPIVersion) { + this.openAPIVersion = openAPIVersion; + return (T) this; + } + protected void register() { OpenApiContextLocator.getInstance().putOpenApiContext(id, this); } @@ -494,6 +518,10 @@ public T init() throws OpenApiConfigurationException { if (schemaResolution != null) { ((SwaggerConfiguration) openApiConfiguration).setSchemaResolution(schemaResolution); } + if (openAPIVersion != null && !openAPIVersion.isEmpty()) { + ((SwaggerConfiguration) openApiConfiguration).openAPIVersion(openAPIVersion); + ((SwaggerConfiguration) openApiConfiguration).setSchemaResolution(schemaResolution); + } } openApiConfiguration = mergeParentConfiguration(openApiConfiguration, parent); diff --git a/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/SwaggerConfiguration.java b/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/SwaggerConfiguration.java index c9896626e3..1d2cbeca79 100644 --- a/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/SwaggerConfiguration.java +++ b/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/SwaggerConfiguration.java @@ -43,6 +43,8 @@ public class SwaggerConfiguration implements OpenAPIConfiguration { private Schema.SchemaResolution schemaResolution = Schema.SchemaResolution.DEFAULT; + private String openAPIVersion = "3.0.1"; + @Override public String getDefaultResponseCode() { return defaultResponseCode; @@ -390,4 +392,27 @@ public SwaggerConfiguration schemaResolution(Schema.SchemaResolution schemaResol this.setSchemaResolution(schemaResolution); return this; } + + /** + * @since 2.2.28 + */ + @Override + public String getOpenAPIVersion() { + return openAPIVersion; + } + + /** + * @since 2.2.28 + */ + public void setOpenAPIVersion(String openAPIVersion) { + this.openAPIVersion = openAPIVersion; + } + + /** + * @since 2.2.28 + */ + public SwaggerConfiguration openAPIVersion(String openAPIVersion) { + this.setOpenAPIVersion(openAPIVersion); + return this; + } } diff --git a/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/api/OpenAPIConfiguration.java b/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/api/OpenAPIConfiguration.java index 4854c2f5a1..4fda4ba906 100644 --- a/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/api/OpenAPIConfiguration.java +++ b/modules/swagger-integration/src/main/java/io/swagger/v3/oas/integration/api/OpenAPIConfiguration.java @@ -74,4 +74,9 @@ public interface OpenAPIConfiguration { * @since 2.2.24 */ public Schema.SchemaResolution getSchemaResolution(); + + /** + * @since 2.2.28 + */ + public String getOpenAPIVersion(); } diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/Reader.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/Reader.java index cac9e1c18a..24e67e4d1d 100644 --- a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/Reader.java +++ b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/Reader.java @@ -122,6 +122,10 @@ protected Reader(OpenAPI openAPI, Paths paths, Set openApiTags, Components this.openApiTags = openApiTags; this.components = components; setConfiguration(openApiConfiguration); + if (openApiConfiguration != null && StringUtils.isNotBlank(openApiConfiguration.getOpenAPIVersion())) { + this.openAPI.openapi(openApiConfiguration.getOpenAPIVersion()); + } + } diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletConfigContextUtils.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletConfigContextUtils.java index a2555f4f0b..3e4ee41ccd 100644 --- a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletConfigContextUtils.java +++ b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletConfigContextUtils.java @@ -68,6 +68,12 @@ public class ServletConfigContextUtils { */ public static final String OPENAPI_CONFIGURATION_SCHEMA_RESOLUTION_KEY = "openApi.configuration.schemaResolution"; + /** + * @since 2.2.28 + */ + public static final String OPENAPI_CONFIGURATION_OPENAPI_VERSION_KEY = "openApi.configuration.openAPIVersion"; + + public static Set resolveResourcePackages(ServletConfig servletConfig) { if (!isServletConfigAvailable(servletConfig)) { return null; diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletOpenApiConfigurationLoader.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletOpenApiConfigurationLoader.java index f54f53769f..a96ab56d53 100644 --- a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletOpenApiConfigurationLoader.java +++ b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletOpenApiConfigurationLoader.java @@ -26,6 +26,7 @@ import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_READER_KEY; import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_SCANNER_KEY; import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_SCHEMA_RESOLUTION_KEY; +import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_OPENAPI_VERSION_KEY; import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_SKIPRESOLVEAPPPATH_KEY; import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_SORTOUTPUT_KEY; import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_ALWAYSRESOLVEAPPPATH_KEY; @@ -75,6 +76,9 @@ public OpenAPIConfiguration load(String path) throws IOException { if (getInitParam(servletConfig, OPENAPI_CONFIGURATION_SCHEMA_RESOLUTION_KEY) != null) { configuration.schemaResolution(Schema.SchemaResolution.valueOf(getInitParam(servletConfig, OPENAPI_CONFIGURATION_SCHEMA_RESOLUTION_KEY))); } + if (getInitParam(servletConfig, OPENAPI_CONFIGURATION_OPENAPI_VERSION_KEY) != null) { + configuration.openAPIVersion(getInitParam(servletConfig, OPENAPI_CONFIGURATION_OPENAPI_VERSION_KEY)); + } return configuration; } diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java index 36e5987c5c..9c8cbda808 100644 --- a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java +++ b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java @@ -52,6 +52,8 @@ public class SwaggerLoader { private String schemaResolution; + private String openAPIVersion; + /** * @since 2.0.6 */ @@ -267,6 +269,20 @@ public void setSchemaResolution(String schemaResolution) { this.schemaResolution = schemaResolution; } + /** + * @since 2.2.28 + */ + public String getOpenAPIVersion() { + return openAPIVersion; + } + + /** + * @since 2.2.28 + */ + public void setOpenAPIVersion(String openAPIVersion) { + this.openAPIVersion = openAPIVersion; + } + public Map resolve() throws Exception{ Set ignoredRoutesSet = null; @@ -321,6 +337,9 @@ public Map resolve() throws Exception{ if (schemaResolution != null) { config.schemaResolution(Schema.SchemaResolution.valueOf(schemaResolution)); } + if (openAPIVersion != null) { + config.openAPIVersion(openAPIVersion); + } try { GenericOpenApiContextBuilder builder = new JaxrsOpenApiContextBuilder() .openApiConfiguration(config); diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java index e3ae222c2c..7949b1a010 100644 --- a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java +++ b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java @@ -4165,4 +4165,25 @@ public void test4483Response() { " type: string\n"; SerializationMatchers.assertEqualsToYaml(openAPI, yaml); } + + @Test(description = "openAPIVersion") + public void testOpenAPIVersion() { + SwaggerConfiguration config = new SwaggerConfiguration().openAPIVersion("3.0.4"); + Reader reader = new Reader(config); + + OpenAPI openAPI = reader.read(DefaultResponseResource.class); + String yaml = "openapi: 3.0.4\n" + + "paths:\n" + + " /:\n" + + " get:\n" + + " operationId: test\n" + + " responses:\n" + + " default:\n" + + " description: default response\n" + + " content:\n" + + " '*/*':\n" + + " schema:\n" + + " type: string\n"; + SerializationMatchers.assertEqualsToYaml(openAPI, yaml); + } } diff --git a/modules/swagger-maven-plugin/README.md b/modules/swagger-maven-plugin/README.md index 011a5260d4..4e6b347ce9 100644 --- a/modules/swagger-maven-plugin/README.md +++ b/modules/swagger-maven-plugin/README.md @@ -176,32 +176,33 @@ Both `javax` and `jakarta` examples are provided below ``` #### Parameters -Parameter | Description | Required | Default ---------- | ----------- |---------| ------- -`outputPath`|output path where file(s) are saved| true | -`outputFileName`|file name (no extension)| false |`openapi` -`outputFormat`|file format (`JSON`, `YAML`, `JSONANDYAML`| false |`JSON` -`skip`|if `TRUE` skip execution| false |`FALSE` -`encoding`|encoding of output file(s)| false | -`resourcePackages`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`resourceClasses`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`prettyPrint`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`TRUE` -`sortOutput`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`FALSE` -`alwaysResolveAppPath`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`FALSE` -`skipResolveAppPath`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`FALSE` -`openapiFilePath`|path to openapi file to be merged with resolved specification, see [config](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`configurationFilePath`|path to swagger config file to be merged with resolved specification, see [config](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration)| false | -`filterClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`readerClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`scannerClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`readAllResources`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`ignoredRoutes`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`objectMapperProcessorClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`defaultResponseCode`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`modelConverterClasses`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`contextId`|see [Context](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#context)| false |${project.artifactId} -`openapi31`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | -`schemaResolution`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| DEFAULT | +Parameter | Description | Required | Default +--------- | ----------- |---------------| ------- +`outputPath`|output path where file(s) are saved| true | +`outputFileName`|file name (no extension)| false |`openapi` +`outputFormat`|file format (`JSON`, `YAML`, `JSONANDYAML`| false |`JSON` +`skip`|if `TRUE` skip execution| false |`FALSE` +`encoding`|encoding of output file(s)| false | +`resourcePackages`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`resourceClasses`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`prettyPrint`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`TRUE` +`sortOutput`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`FALSE` +`alwaysResolveAppPath`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`FALSE` +`skipResolveAppPath`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false |`FALSE` +`openapiFilePath`|path to openapi file to be merged with resolved specification, see [config](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`configurationFilePath`|path to swagger config file to be merged with resolved specification, see [config](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration)| false | +`filterClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`readerClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`scannerClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`readAllResources`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`ignoredRoutes`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`objectMapperProcessorClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`defaultResponseCode`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`modelConverterClasses`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`contextId`|see [Context](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#context)| false |${project.artifactId} +`openapi31`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| false | +`schemaResolution`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| DEFAULT | +`openAPIVersion`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)| `3.0.1/3.1.0` | *** @@ -213,4 +214,5 @@ Since version 2.1.9, `alwaysResolveAppPath` parameter is available, allowing to Since version 2.2.12, `openapi31` parameter is available, if set to true the resolved spec will be processed into a 3.1.0 specification by resolving according to OAS 3.1 rules Since version 2.1.15, `skipResolveAppPath` parameter is available, allowing to skip resolving of Application Path from annotation Since version 2.2.17, `defaultResponseCode` parameter is available, allowing to set the code used when resolving responses with no http status code annotation -Since version 2.2.24, `schemaResolution` parameter is available, allowing to specify how object schemas and object properties within schemas are resolved for OAS 3.0 specification \ No newline at end of file +Since version 2.2.24, `schemaResolution` parameter is available, allowing to specify how object schemas and object properties within schemas are resolved for OAS 3.0 specification +Since version 2.2.28, `openAPIVersion` parameter is available, allowing to specify the version of the OpenAPI specification to be used for the resolved spec. diff --git a/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java b/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java index 60bafc3d44..b0edfb6005 100644 --- a/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java +++ b/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java @@ -361,6 +361,10 @@ private SwaggerConfiguration mergeConfig(OpenAPI openAPIInput, SwaggerConfigurat config.schemaResolution(Schema.SchemaResolution.valueOf(schemaResolution)); } + if (StringUtils.isNotBlank(openAPIVersion)) { + config.openAPIVersion(openAPIVersion); + } + return config; } @@ -465,6 +469,12 @@ private boolean isCollectionNotBlank(Collection collection) { @Parameter(property = "resolve.schemaResolution") private String schemaResolution; + /** + * @since 2.2.28 + */ + @Parameter(property = "resolve.openAPIVersion") + private String openAPIVersion; + private String projectEncoding = "UTF-8"; private SwaggerConfiguration config; diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java index 0db5e18817..bd40c16a15 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java @@ -18,7 +18,7 @@ /** * Components * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#componentsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#componentsObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#componentsObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java index c5f0ccb1be..91b608ae3b 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java @@ -7,7 +7,7 @@ /** * ExternalDocumentation * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#externalDocumentationObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#externalDocumentationObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#externalDocumentationObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java index 7f287f95f6..eb63020388 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java @@ -18,7 +18,7 @@ /** * OpenAPI * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java index 0ee0906788..29d606fff6 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java @@ -17,7 +17,7 @@ /** * Operation * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#operationObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#operationObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#operationObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java index a36bdfbe70..1746242ec9 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java @@ -12,7 +12,7 @@ /** * PathItem * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#pathItemObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#pathItemObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#pathItemObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java index ed7149084c..dba34ddcfd 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java @@ -8,7 +8,7 @@ /** * Paths * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#pathsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#pathsObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#pathsObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java index 4e3fb65527..835e50a1d1 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java @@ -9,7 +9,7 @@ /** * Callback * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#callbackObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#callbackObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#callbackObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java index 0d9813133a..7d5b1bca43 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java @@ -5,7 +5,7 @@ /** * Example * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#exampleObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#exampleObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#exampleObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java index 11b6b973a0..eb234dbf9c 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java @@ -11,7 +11,7 @@ /** * Header * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#headerObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#headerObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#headerObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java index fbb23a62f3..3f50b5d0fc 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java @@ -7,7 +7,7 @@ /** * Contact * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#contactObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#contactObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#contactObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java index 9fdc498581..2710238a8a 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java @@ -5,7 +5,7 @@ import java.util.Objects; /** - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#infoObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#infoObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#infoObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java index 42e1c3ad46..8d4561fd84 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java @@ -7,7 +7,7 @@ /** * License * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#licenseObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#licenseObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#licenseObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java index 77bc884af8..7b153d3501 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java @@ -10,7 +10,7 @@ /** * Link * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#linkObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#linkObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#linkObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java index da0e443810..bf13f2b06c 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java @@ -6,7 +6,7 @@ /** * Content * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#contentObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#contentObject" */ public class Content extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java index 1bd7529151..22fded1dde 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java @@ -10,7 +10,7 @@ /** * Encoding * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#encodingObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#encodingObject" */ public class Encoding { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java index 40894f195c..9a32560e6b 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java @@ -10,7 +10,7 @@ /** * EncodingProperty * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#encodingPropertyObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#encodingPropertyObject" */ public class EncodingProperty { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java index 44bf334be8..e84ed19b84 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java @@ -10,7 +10,7 @@ /** * MediaType * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#mediaTypeObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#mediaTypeObject" */ public class MediaType { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java index dbea8e491a..9d234e8376 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java @@ -21,7 +21,7 @@ /** * Schema * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#schemaObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#schemaObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#schemaObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java index 0269dbf530..16e210631e 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java @@ -7,7 +7,7 @@ /** * XML * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#xmlObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#xmlObject" */ public class XML { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java index 14f22a61c2..f5dbe46ed1 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java @@ -12,7 +12,7 @@ /** * Parameter * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#parameterObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#parameterObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#parameterObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java index 14d2dea268..9a7746e398 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java @@ -6,7 +6,7 @@ /** * RequestBody * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#requestBodyObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#requestBodyObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#requestBodyObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java index 6b82722b18..1b16d9ba85 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java @@ -12,7 +12,7 @@ /** * ApiResponse * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#responseObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#responseObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#responseObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java index 892c62dc77..b974e8be72 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java @@ -8,7 +8,7 @@ /** * ApiResponses * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#responsesObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#responsesObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#responsesObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java index 829b9f1dfa..eb477a1fc8 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java @@ -7,7 +7,7 @@ /** * OAuthFlow * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#oauthFlowsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#oauthFlowsObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#oauthFlowsObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java index 367b59b463..816a7901cc 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java @@ -7,7 +7,7 @@ /** * OAuthFlows * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#oauthFlowsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#oauthFlowsObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#oauthFlowsObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java index ef21d23876..813f661792 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java @@ -6,7 +6,7 @@ /** * Scopes * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#scopedObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#scopedObject" */ public class Scopes extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java index e94ca4b05d..785e7143e4 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java @@ -9,7 +9,7 @@ /** * SecurityRequirement * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#securityRequirementObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#securityRequirementObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#securityRequirementObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java index 80b8a2856a..f3213bb431 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java @@ -5,7 +5,7 @@ /** * SecurityScheme * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#securitySchemeObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#securitySchemeObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#securitySchemeObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java index f43b6234e6..8d6d57c8dc 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java @@ -7,7 +7,7 @@ /** * Server * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#serverObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#serverObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#serverObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java index cad53ce1ed..3ff6819e4b 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java @@ -9,7 +9,7 @@ /** * ServerVariable * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#serverVariableObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#serverVariableObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#serverVariableObject" */ diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java index 62ba9a529d..dd7bb16a96 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java @@ -6,7 +6,7 @@ /** * ServerVariables * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#serverVariablesObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#serverVariablesObject" */ public class ServerVariables extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java index 57fd2876a1..4931aa5684 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java @@ -8,7 +8,7 @@ /** * Tag * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#tagObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#tagObject" * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#tagObject" */ From 3e8f85843522c4235e784d31c678a4f97bca6f4c Mon Sep 17 00:00:00 2001 From: frantuma Date: Mon, 6 Jan 2025 15:14:23 +0100 Subject: [PATCH 2/3] updated links to spec (see https://github.com/OAI/OpenAPI-Specification/pull/3548) --- .../swagger/v3/oas/annotations/ExternalDocumentation.java | 4 ++-- .../io/swagger/v3/oas/annotations/OpenAPIDefinition.java | 2 +- .../main/java/io/swagger/v3/oas/annotations/Operation.java | 2 +- .../main/java/io/swagger/v3/oas/annotations/Parameter.java | 2 +- .../main/java/io/swagger/v3/oas/annotations/Webhook.java | 2 +- .../io/swagger/v3/oas/annotations/callbacks/Callback.java | 2 +- .../io/swagger/v3/oas/annotations/extensions/Extension.java | 2 +- .../java/io/swagger/v3/oas/annotations/headers/Header.java | 2 +- .../java/io/swagger/v3/oas/annotations/info/Contact.java | 2 +- .../main/java/io/swagger/v3/oas/annotations/info/Info.java | 4 ++-- .../java/io/swagger/v3/oas/annotations/info/License.java | 4 ++-- .../main/java/io/swagger/v3/oas/annotations/links/Link.java | 2 +- .../io/swagger/v3/oas/annotations/media/ArraySchema.java | 4 ++-- .../java/io/swagger/v3/oas/annotations/media/Content.java | 2 +- .../v3/oas/annotations/media/DiscriminatorMapping.java | 4 ++-- .../java/io/swagger/v3/oas/annotations/media/Encoding.java | 2 +- .../io/swagger/v3/oas/annotations/media/ExampleObject.java | 2 +- .../java/io/swagger/v3/oas/annotations/media/Schema.java | 4 ++-- .../swagger/v3/oas/annotations/parameters/RequestBody.java | 2 +- .../swagger/v3/oas/annotations/responses/ApiResponse.java | 2 +- .../v3/oas/annotations/security/SecurityRequirement.java | 2 +- .../swagger/v3/oas/annotations/security/SecurityScheme.java | 6 +++--- .../java/io/swagger/v3/oas/annotations/servers/Server.java | 2 +- .../main/java/io/swagger/v3/oas/annotations/tags/Tag.java | 2 +- .../src/main/java/io/swagger/v3/oas/models/Components.java | 4 ++-- .../io/swagger/v3/oas/models/ExternalDocumentation.java | 4 ++-- .../src/main/java/io/swagger/v3/oas/models/OpenAPI.java | 2 +- .../src/main/java/io/swagger/v3/oas/models/Operation.java | 4 ++-- .../src/main/java/io/swagger/v3/oas/models/PathItem.java | 4 ++-- .../src/main/java/io/swagger/v3/oas/models/Paths.java | 4 ++-- .../java/io/swagger/v3/oas/models/callbacks/Callback.java | 4 ++-- .../java/io/swagger/v3/oas/models/examples/Example.java | 4 ++-- .../main/java/io/swagger/v3/oas/models/headers/Header.java | 4 ++-- .../main/java/io/swagger/v3/oas/models/info/Contact.java | 4 ++-- .../src/main/java/io/swagger/v3/oas/models/info/Info.java | 4 ++-- .../main/java/io/swagger/v3/oas/models/info/License.java | 4 ++-- .../src/main/java/io/swagger/v3/oas/models/links/Link.java | 4 ++-- .../main/java/io/swagger/v3/oas/models/media/Content.java | 2 +- .../main/java/io/swagger/v3/oas/models/media/Encoding.java | 2 +- .../io/swagger/v3/oas/models/media/EncodingProperty.java | 2 +- .../main/java/io/swagger/v3/oas/models/media/MediaType.java | 2 +- .../main/java/io/swagger/v3/oas/models/media/Schema.java | 4 ++-- .../src/main/java/io/swagger/v3/oas/models/media/XML.java | 2 +- .../java/io/swagger/v3/oas/models/parameters/Parameter.java | 4 ++-- .../io/swagger/v3/oas/models/parameters/RequestBody.java | 4 ++-- .../io/swagger/v3/oas/models/responses/ApiResponse.java | 4 ++-- .../io/swagger/v3/oas/models/responses/ApiResponses.java | 4 ++-- .../java/io/swagger/v3/oas/models/security/OAuthFlow.java | 4 ++-- .../java/io/swagger/v3/oas/models/security/OAuthFlows.java | 4 ++-- .../main/java/io/swagger/v3/oas/models/security/Scopes.java | 2 +- .../swagger/v3/oas/models/security/SecurityRequirement.java | 4 ++-- .../io/swagger/v3/oas/models/security/SecurityScheme.java | 4 ++-- .../main/java/io/swagger/v3/oas/models/servers/Server.java | 4 ++-- .../io/swagger/v3/oas/models/servers/ServerVariable.java | 4 ++-- .../io/swagger/v3/oas/models/servers/ServerVariables.java | 2 +- .../src/main/java/io/swagger/v3/oas/models/tags/Tag.java | 4 ++-- 56 files changed, 88 insertions(+), 88 deletions(-) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java index 14f0df4ba8..e070b34dc1 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/ExternalDocumentation.java @@ -13,12 +13,12 @@ /** * The annotation may be used at method level or as field of {@link Operation} to add a reference to an external - * resource for extended documentation of an Operation (OpenAPI specification). + * resource for extended documentation of an Operation (OpenAPI specification). *

    It may also be used to add external documentation to {@link io.swagger.v3.oas.annotations.tags.Tag}, * {@link io.swagger.v3.oas.annotations.headers.Header} or {@link io.swagger.v3.oas.annotations.media.Schema}, * or as field of {@link OpenAPIDefinition}.

    * - * @see External Documentation (OpenAPI specification) + * @see External Documentation (OpenAPI specification) * @see OpenAPIDefinition **/ @Target({METHOD, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java index c32fdd8776..5fcdcee883 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/OpenAPIDefinition.java @@ -19,7 +19,7 @@ * The annotation that may be used to populate OpenAPI Object fields info, tags, servers, security and externalDocs * If more than one class is annotated with {@link OpenAPIDefinition}, with the same fields defined, behaviour is inconsistent. * - * @see OpenAPI (OpenAPI specification) + * @see OpenAPI (OpenAPI specification) */ @Target({TYPE, PACKAGE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java index e957df72ee..e307777104 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Operation.java @@ -38,7 +38,7 @@ *
  • hidden: @{@link Hidden}
    • * * - * @see Operation (OpenAPI specification) + * @see Operation (OpenAPI specification) **/ @Target({METHOD, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java index fb59366bdd..00543d82a7 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Parameter.java @@ -30,7 +30,7 @@ * *

    For method parameters bound to the request body, see {@link io.swagger.v3.oas.annotations.parameters.RequestBody}

    * - * @see Parameter (OpenAPI specification) + * @see Parameter (OpenAPI specification) * @see io.swagger.v3.oas.annotations.parameters.RequestBody * @see Operation * @see Schema diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Webhook.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Webhook.java index 9a50a4034d..92c13eae25 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Webhook.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/Webhook.java @@ -11,7 +11,7 @@ /** * The annotation may be used to define a method as an OpenAPI Webhook. * - * @see Webhook (OpenAPI specification) + * @see Webhook (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition **/ @Target({METHOD, ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java index 6b128c9357..8e954604a8 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/callbacks/Callback.java @@ -18,7 +18,7 @@ /** * The annotation may be used at method level to add one ore more callbacks to the operation definition. * - * @see Callback (OpenAPI specification) + * @see Callback (OpenAPI specification) **/ @Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java index 92d2d03acb..2819af6c08 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/extensions/Extension.java @@ -14,7 +14,7 @@ /** * An optionally named list of extension properties. * - * @see Specification extensions (OpenAPI specification) + * @see Specification extensions (OpenAPI specification) */ @Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java index 7dc88e55d9..b47faa301c 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java @@ -15,7 +15,7 @@ * encoding by defining it as field {@link io.swagger.v3.oas.annotations.responses.ApiResponse#headers()} or {@link io.swagger.v3.oas.annotations.media.Content#encoding()}. *

    Please note that request headers are defined as Header {@link io.swagger.v3.oas.annotations.Parameter}.

    * - * @see Header (OpenAPI specification) + * @see Header (OpenAPI specification) * @see io.swagger.v3.oas.annotations.responses.ApiResponse * @see io.swagger.v3.oas.annotations.Parameter * @see io.swagger.v3.oas.annotations.media.Encoding diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java index 723e1d80c2..01e76686c8 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Contact.java @@ -9,7 +9,7 @@ /** * The annotation may be used in {@link Info#contact()} to define a contact for the OpenAPI spec. * - * @see Contact (OpenAPI specification) + * @see Contact (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see Info **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java index 0c8b2a4490..df18681598 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/Info.java @@ -12,8 +12,8 @@ /** * The annotation may be used in {@link io.swagger.v3.oas.annotations.OpenAPIDefinition#info()} to populate the Info section of the OpenAPI document. * - * @see Info (OpenAPI specification) - * @see Info (OpenAPI specification) + * @see Info (OpenAPI specification) + * @see Info (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition **/ @Target({ElementType.ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java index 5faed40537..100056774a 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/info/License.java @@ -10,8 +10,8 @@ /** * The annotation may be used in {@link Info#license()} to define a license for the OpenAPI spec. * - * @see License (OpenAPI 3.0 pecification) - * @see License (OpenAPI 3.1 specification) + * @see License (OpenAPI 3.0 pecification) + * @see License (OpenAPI 3.1 specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see Info **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java index 0551576797..456efa3ba2 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/links/Link.java @@ -12,7 +12,7 @@ /** * The annotation may be applied in {@link io.swagger.v3.oas.annotations.responses.ApiResponse#links()} to add OpenAPI links to a response. * - * @see Link (OpenAPI specification) + * @see Link (OpenAPI specification) * @see io.swagger.v3.oas.annotations.responses.ApiResponse **/ @Target({ElementType.ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java index 8b43a9ff0b..09cd4fcefc 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ArraySchema.java @@ -25,8 +25,8 @@ *

    The annotation {@link Schema} shall be used for non array elements; {@link ArraySchema} and {@link Schema} cannot * coexist

    * - * @see Schema (OpenAPI specification) - * @see Schema (OpenAPI specification) + * @see Schema (OpenAPI specification) + * @see Schema (OpenAPI specification) * @see Schema **/ @Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java index 1fe4a03f84..55c39d87b6 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java @@ -16,7 +16,7 @@ * JAX-RS annotations, element type and context as input to resolve the annotated element into an OpenAPI schema * definition for such element.

    * - * @see Example (OpenAPI specification) + * @see Example (OpenAPI specification) * @see Schema * @see io.swagger.v3.oas.annotations.Parameter * @see io.swagger.v3.oas.annotations.responses.ApiResponse diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java index 69c94bc42e..44426e9f83 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/DiscriminatorMapping.java @@ -15,8 +15,8 @@ * *

    Use {@link Schema#discriminatorProperty()} to define a discriminator property.

    * - * @see Discriminator (OpenAPI specification) - * @see Discriminator (OpenAPI specification) + * @see Discriminator (OpenAPI specification) + * @see Discriminator (OpenAPI specification) * @see Schema **/ @Target({}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java index 6e29335b34..b5b293bc0b 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java @@ -12,7 +12,7 @@ * The annotation may be used to add encoding details to the definition of a parameter, request or response content, * by defining it as field {@link Content#encoding()} * - * @see Encoding (OpenAPI specification) + * @see Encoding (OpenAPI specification) * @see Content **/ @Target({}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java index 66e4df5a18..9fa9088782 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java @@ -12,7 +12,7 @@ * The annotation may be used to add one or more examples to the definition of a parameter, request or response content, * by defining it as field {@link io.swagger.v3.oas.annotations.Parameter#examples()} or {@link Content#examples()} * - * @see Example (OpenAPI specification) + * @see Example (OpenAPI specification) **/ @Target({ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java index df2e512671..eecf74aa1e 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Schema.java @@ -30,8 +30,8 @@ *

    The annotation {@link ArraySchema} shall be used for array elements; {@link ArraySchema} and {@link Schema} cannot * coexist

    * - * @see Schema (OpenAPI specification) - * @see Schema (OpenAPI specification) + * @see Schema (OpenAPI specification) + * @see Schema (OpenAPI specification) * @see ArraySchema **/ @Target({FIELD, METHOD, PARAMETER, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java index b306a61120..975f970bda 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/parameters/RequestBody.java @@ -16,7 +16,7 @@ * The annotation may be used on a method parameter to define it as the Request Body of the operation, and/or to define * additional properties for such request body. * - * @see Request Body (OpenAPI specification) + * @see Request Body (OpenAPI specification) * @see io.swagger.v3.oas.annotations.Parameter * @see Content **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java index da021f6990..a21e3ad110 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/responses/ApiResponse.java @@ -22,7 +22,7 @@ *

    swagger-jaxrs2 reader engine considers this annotation along with method return type and context as input to * resolve the OpenAPI Operation responses.

    * - * @see Response (OpenAPI specification) + * @see Response (OpenAPI specification) * @see io.swagger.v3.oas.annotations.Operation **/ @Target({METHOD, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java index 23c6d1dd08..989a7386fc 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityRequirement.java @@ -15,7 +15,7 @@ * single operation (when applied at method level) or for all operations of a class (when applied at class level). *

    It can also be used in {@link io.swagger.v3.oas.annotations.OpenAPIDefinition#security()} to define spec level security.

    * - * @see Security Requirement (OpenAPI specification) + * @see Security Requirement (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see io.swagger.v3.oas.annotations.Operation **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java index bf424451ef..9a4f3c7c1c 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/security/SecurityScheme.java @@ -17,8 +17,8 @@ * The annotation may be used at class level (also on multiple classes) to add securitySchemes to spec * components section. * - * @see Security Scheme (OpenAPI specification) - * @see Components (OpenAPI specification) + * @see Security Scheme (OpenAPI specification) + * @see Components (OpenAPI specification) **/ @Target({TYPE, ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) @@ -48,7 +48,7 @@ /** * The name of the header or query parameter to be used. Applies to apiKey type. - * Maps to "name" property of Security Scheme (OpenAPI specification) + * Maps to "name" property of Security Scheme (OpenAPI specification) * * @return String paramName **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java index 8aedc2028a..f38c554ee8 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/servers/Server.java @@ -17,7 +17,7 @@ * single operation (when applied at method level) or for all operations of a class (when applied at class level). *

    It can also be used in {@link io.swagger.v3.oas.annotations.OpenAPIDefinition#servers()} to define spec level servers.

    * - * @see Server (OpenAPI specification) + * @see Server (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition * @see io.swagger.v3.oas.annotations.Operation **/ diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java index 46c378fb98..c2e872152b 100644 --- a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java +++ b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/tags/Tag.java @@ -21,7 +21,7 @@ * if additional fields are also defined, like description or externalDocs, the Tag will also be added to openAPI.tags * field

    * - * @see Tag (OpenAPI specification) + * @see Tag (OpenAPI specification) * @see io.swagger.v3.oas.annotations.OpenAPIDefinition **/ @Target({METHOD, TYPE, ANNOTATION_TYPE}) diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java index bd40c16a15..ad638fd310 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java @@ -18,8 +18,8 @@ /** * Components * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#componentsObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#componentsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#components-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#components-object" */ public class Components { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java index 91b608ae3b..16517149e0 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java @@ -7,8 +7,8 @@ /** * ExternalDocumentation * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#externalDocumentationObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#externalDocumentationObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#external-documentation-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#external-documentation-object" */ public class ExternalDocumentation { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java index eb63020388..f4a06f81ec 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java @@ -19,7 +19,7 @@ * OpenAPI * * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md" */ public class OpenAPI { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java index 29d606fff6..585b9be6a5 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java @@ -17,8 +17,8 @@ /** * Operation * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#operationObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#operationObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#operation-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#operation-object" */ public class Operation { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java index 1746242ec9..35de0a6baf 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java @@ -12,8 +12,8 @@ /** * PathItem * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#pathItemObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#pathItemObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#path-item-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#path-item-object" */ public class PathItem { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java index dba34ddcfd..fb49ec1cf8 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java @@ -8,8 +8,8 @@ /** * Paths * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#pathsObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#pathsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#paths-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#paths-object" */ public class Paths extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java index 835e50a1d1..a43c9bc521 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java @@ -9,8 +9,8 @@ /** * Callback * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#callbackObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#callbackObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#callback-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#callback-object" */ public class Callback extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java index 7d5b1bca43..ae6ca234c8 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java @@ -5,8 +5,8 @@ /** * Example * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#exampleObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#exampleObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#example-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#example-object" */ public class Example { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java index eb234dbf9c..5fe479795c 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java @@ -11,8 +11,8 @@ /** * Header * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#headerObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#headerObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#header-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#header-object" */ public class Header { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java index 3f50b5d0fc..f63bb0443b 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java @@ -7,8 +7,8 @@ /** * Contact * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#contactObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#contactObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#contact-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#contact-object" */ public class Contact { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java index 2710238a8a..20807d2db3 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Info.java @@ -5,8 +5,8 @@ import java.util.Objects; /** - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#infoObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#infoObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#info-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#info-object" */ public class Info { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java index 8d4561fd84..296d73ee29 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/License.java @@ -7,8 +7,8 @@ /** * License * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#licenseObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#licenseObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#license-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#license-object" */ public class License { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java index 7b153d3501..a51eba18f5 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/links/Link.java @@ -10,8 +10,8 @@ /** * Link * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#linkObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#linkObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#link-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#link-object" */ public class Link { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java index bf13f2b06c..e3d6afc21c 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Content.java @@ -6,7 +6,7 @@ /** * Content * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#contentObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#content-object" */ public class Content extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java index 22fded1dde..cb711622aa 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Encoding.java @@ -10,7 +10,7 @@ /** * Encoding * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#encodingObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#encoding-object" */ public class Encoding { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java index 9a32560e6b..9aff35368d 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/EncodingProperty.java @@ -10,7 +10,7 @@ /** * EncodingProperty * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#encodingPropertyObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#encoding-property-object" */ public class EncodingProperty { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java index e84ed19b84..4e0c5e9277 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/MediaType.java @@ -10,7 +10,7 @@ /** * MediaType * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#mediaTypeObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#media-type-object" */ public class MediaType { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java index 9d234e8376..e1acb9d55a 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java @@ -21,8 +21,8 @@ /** * Schema * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#schemaObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#schemaObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#schema-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#schema-object" */ public class Schema { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java index 16e210631e..dad66ff647 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/XML.java @@ -7,7 +7,7 @@ /** * XML * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#xmlObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#xml-object" */ public class XML { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java index f5dbe46ed1..e9242cb2ea 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/Parameter.java @@ -12,8 +12,8 @@ /** * Parameter * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#parameterObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#parameterObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#parameter-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#parameter-object" */ public class Parameter { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java index 9a7746e398..9ac0226da7 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/parameters/RequestBody.java @@ -6,8 +6,8 @@ /** * RequestBody * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#requestBodyObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#requestBodyObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#requestBody-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#request-body-object" */ public class RequestBody { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java index 1b16d9ba85..7549cc9d47 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponse.java @@ -12,8 +12,8 @@ /** * ApiResponse * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#responseObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#responseObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#response-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#response-object" */ public class ApiResponse { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java index b974e8be72..fac8020792 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java @@ -8,8 +8,8 @@ /** * ApiResponses * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#responsesObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#responsesObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#responses-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#responses-object" */ public class ApiResponses extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java index eb477a1fc8..16bbdeade3 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlow.java @@ -7,8 +7,8 @@ /** * OAuthFlow * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#oauthFlowsObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#oauthFlowsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#oauth-flows-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#oauth-flows-object" */ public class OAuthFlow { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java index 816a7901cc..31d74f5507 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/OAuthFlows.java @@ -7,8 +7,8 @@ /** * OAuthFlows * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#oauthFlowsObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#oauthFlowsObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#oauth-flows-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#oauth-flows-object" */ public class OAuthFlows { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java index 813f661792..185c256826 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/Scopes.java @@ -6,7 +6,7 @@ /** * Scopes * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#scopedObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#scoped-object" */ public class Scopes extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java index 785e7143e4..cd0b7e4d54 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityRequirement.java @@ -9,8 +9,8 @@ /** * SecurityRequirement * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#securityRequirementObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#securityRequirementObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#security-requirement-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#security-requirement-object" */ public class SecurityRequirement extends LinkedHashMap> { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java index f3213bb431..75bb6b30d5 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/security/SecurityScheme.java @@ -5,8 +5,8 @@ /** * SecurityScheme * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#securitySchemeObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#securitySchemeObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#security-scheme-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#security-scheme-object" */ public class SecurityScheme { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java index 8d6d57c8dc..eb8be59e56 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/Server.java @@ -7,8 +7,8 @@ /** * Server * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#serverObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#serverObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#server-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#server-object" */ public class Server { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java index 3ff6819e4b..25083db03f 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariable.java @@ -9,8 +9,8 @@ /** * ServerVariable * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#serverVariableObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#serverVariableObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#server-variable-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#server-variable-object" */ public class ServerVariable { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java index dd7bb16a96..f3d4c7c6c1 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/servers/ServerVariables.java @@ -6,7 +6,7 @@ /** * ServerVariables * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#serverVariablesObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#server-variables-object" */ public class ServerVariables extends LinkedHashMap { diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java index 4931aa5684..4efe150280 100644 --- a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java +++ b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/tags/Tag.java @@ -8,8 +8,8 @@ /** * Tag * - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#tagObject" - * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#tagObject" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#tag-object" + * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#tag-object" */ public class Tag { From 36418412a56f70e1aa69bfa96a012816e2f0ffa2 Mon Sep 17 00:00:00 2001 From: frantuma Date: Mon, 6 Jan 2025 15:27:16 +0100 Subject: [PATCH 3/3] fix openAPI version parameter in gradle plugin --- .../java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java b/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java index 07f812b564..b6b11c3198 100644 --- a/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java +++ b/modules/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java @@ -131,7 +131,7 @@ public enum Format {JSON, YAML, JSONANDYAML} @Input @Optional - private String openAPIVersion; + private Property openAPIVersion = getProject().getObjects().property(String.class);; @Input @Optional