[Java][Spring] Fix #14398 springboot 3 schema required (#14402)

* fix depricated @Schema(required) since swagger 2.2.5 * use same swagger-annotations version which is used by swagger-core which is a dependency of springdoc * generated java sampes
OpenAPITools · Jan 14, 2023 · be87382 · be87382
1 parent 7958990
commit be87382
Show file tree

Hide file tree

Showing 459 changed files with 1,583 additions and 1,583 deletions.
diff --git a/...es/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/pom-sb3.mustache b/...es/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/pom-sb3.mustache
@@ -15,7 +15,7 @@
         {{/springDocDocumentationProvider}}
         {{^springDocDocumentationProvider}}
         {{#swagger2AnnotationLibrary}}
-        <swagger-annotations.version>}2.2.0</swagger-annotations.version>
+        <swagger-annotations.version>}2.2.7</swagger-annotations.version>
         {{/swagger2AnnotationLibrary}}
         {{/springDocDocumentationProvider}}
         {{#useSwaggerUI}}

diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/pom.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/pom.mustache
@@ -22,7 +22,7 @@
         <swagger-annotations.version>1.6.6</swagger-annotations.version>
         {{/swagger1AnnotationLibrary}}
         {{#swagger2AnnotationLibrary}}
-        <swagger-annotations.version>}2.1.13</swagger-annotations.version>
+        <swagger-annotations.version>}2.2.7</swagger-annotations.version>
         {{/swagger2AnnotationLibrary}}
         {{/springDocDocumentationProvider}}
         {{/springFoxDocumentationProvider}}

diff --git a/...s/openapi-generator/src/main/resources/JavaSpring/libraries/spring-cloud/pom-sb3.mustache b/...s/openapi-generator/src/main/resources/JavaSpring/libraries/spring-cloud/pom-sb3.mustache
@@ -15,7 +15,7 @@
         {{/springDocDocumentationProvider}}
         {{^springDocDocumentationProvider}}
         {{#swagger2AnnotationLibrary}}
-        <swagger-annotations.version>}2.2.0</swagger-annotations.version>
+        <swagger-annotations.version>}2.2.7</swagger-annotations.version>
         {{/swagger2AnnotationLibrary}}
         {{/springDocDocumentationProvider}}
     </properties>

diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-cloud/pom.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-cloud/pom.mustache
@@ -22,7 +22,7 @@
         <swagger-annotations.version>1.6.6</swagger-annotations.version>
         {{/swagger1AnnotationLibrary}}
         {{#swagger2AnnotationLibrary}}
-        <swagger-annotations.version>}2.1.13</swagger-annotations.version>
+        <swagger-annotations.version>}2.2.7</swagger-annotations.version>
         {{/swagger2AnnotationLibrary}}
         {{/springDocDocumentationProvider}}
         {{/springFoxDocumentationProvider}}

diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
@@ -150,7 +150,7 @@ public class {{classname}}{{#parent}} extends {{{parent}}}{{/parent}}{{^parent}}
   {{#required}}@NotNull{{/required}}
   {{/useBeanValidation}}
   {{#swagger2AnnotationLibrary}}
-  @Schema(name = "{{{baseName}}}", {{#isReadOnly}}accessMode = Schema.AccessMode.READ_ONLY, {{/isReadOnly}}{{#example}}example = "{{{.}}}", {{/example}}{{#description}}description = "{{{.}}}", {{/description}}required = {{{required}}})
+  @Schema(name = "{{{baseName}}}"{{#isReadOnly}}, accessMode = Schema.AccessMode.READ_ONLY{{/isReadOnly}}{{#example}}, example = "{{{.}}}"{{/example}}{{#description}}, description = "{{{.}}}"{{/description}}, requiredMode = {{#required}}Schema.RequiredMode.REQUIRED{{/required}}{{^required}}Schema.RequiredMode.NOT_REQUIRED{{/required}})
   {{/swagger2AnnotationLibrary}}
   {{#swagger1AnnotationLibrary}}
   @ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}")

diff --git a/modules/openapi-generator/src/main/resources/java-camel-server/pom.mustache b/modules/openapi-generator/src/main/resources/java-camel-server/pom.mustache
@@ -128,7 +128,7 @@ Do not edit the class manually.
         <dependency>
             <groupId>io.swagger.core.v3</groupId>
             <artifactId>swagger-annotations</artifactId>
-            <version>2.1.11</version>
+            <version>2.2.7</version>
         </dependency>
         {{/oas3}}
         {{#jackson}}

diff --git a/...openapi-generator/src/main/resources/java-micronaut/common/configuration/pom.xml.mustache b/...openapi-generator/src/main/resources/java-micronaut/common/configuration/pom.xml.mustache
@@ -26,7 +26,7 @@
         <swagger-annotations-version>1.6.5</swagger-annotations-version>
         {{/generateSwagger1Annotations}}
         {{#generateSwagger2Annotations}}
-        <swagger-annotations-version>2.2.0</swagger-annotations-version>
+        <swagger-annotations-version>2.2.7</swagger-annotations-version>
         {{/generateSwagger2Annotations}}
     </properties>
 

diff --git a/modules/openapi-generator/src/main/resources/java-micronaut/common/model/pojo.mustache b/modules/openapi-generator/src/main/resources/java-micronaut/common/model/pojo.mustache
@@ -190,7 +190,7 @@ Declare the class with extends and implements
     @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}")
         {{/generateSwagger1Annotations}}
         {{#generateSwagger2Annotations}}
-    @Schema(name = "{{{baseName}}}", {{#isReadOnly}}accessMode = Schema.AccessMode.READ_ONLY, {{/isReadOnly}}{{#example}}example = "{{{.}}}", {{/example}}{{#description}}description = "{{{.}}}", {{/description}}required = {{{required}}})
+    @Schema(name = "{{{baseName}}}"{{#isReadOnly}}, accessMode = Schema.AccessMode.READ_ONLY{{/isReadOnly}}{{#example}}, example = "{{{.}}}"{{/example}}{{#description}}, description = "{{{.}}}"{{/description}}, requiredMode = {{#required}}Schema.RequiredMode.REQUIRED{{/required}}{{^required}}Schema.RequiredMode.NOT_REQUIRED{{/required}})
         {{/generateSwagger2Annotations}}
         {{#vendorExtensions.x-extra-annotation}}
     {{{vendorExtensions.x-extra-annotation}}}

diff --git a/modules/openapi-generator/src/main/resources/kotlin-spring/interfaceOptVar.mustache b/modules/openapi-generator/src/main/resources/kotlin-spring/interfaceOptVar.mustache
@@ -1,4 +1,4 @@
 {{#swagger2AnnotationLibrary}}
-        @Schema({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
+        @Schema({{#example}}example = "{{{.}}}", {{/example}}{{#required}}requiredMode = Schema.RequiredMode.REQUIRED, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
         @ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{/swagger1AnnotationLibrary}}
         {{>modelMutable}} {{{name}}}: {{#isEnum}}{{classname}}.{{nameInCamelCase}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}? {{^discriminator}}= {{{defaultValue}}}{{^defaultValue}}null{{/defaultValue}}{{/discriminator}}
diff --git a/modules/openapi-generator/src/main/resources/kotlin-spring/interfaceReqVar.mustache b/modules/openapi-generator/src/main/resources/kotlin-spring/interfaceReqVar.mustache
@@ -1,4 +1,4 @@
 {{#swagger2AnnotationLibrary}}
-        @Schema({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
+        @Schema({{#example}}example = "{{{.}}}", {{/example}}{{#required}}requiredMode = Schema.RequiredMode.REQUIRED, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
         @ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{/swagger1AnnotationLibrary}}
         {{>modelMutable}} {{{name}}}: {{#isEnum}}{{classname}}.{{nameInCamelCase}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}
diff --git a/...penapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Category.java b/...penapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Category.java
@@ -38,7 +38,7 @@ public Category id(Long id) {
    * @return id
   */
 
-  @Schema(name = "id", required = false)
+  @Schema(name = "id", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Long getId() {
     return id;
   }
@@ -57,7 +57,7 @@ public Category name(String name) {
    * @return name
   */
   @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") 
-  @Schema(name = "name", required = false)
+  @Schema(name = "name", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getName() {
     return name;
   }

diff --git a/...client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/ModelApiResponse.java b/...client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/ModelApiResponse.java
@@ -43,7 +43,7 @@ public ModelApiResponse code(Integer code) {
    * @return code
   */
 
-  @Schema(name = "code", required = false)
+  @Schema(name = "code", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Integer getCode() {
     return code;
   }
@@ -62,7 +62,7 @@ public ModelApiResponse type(String type) {
    * @return type
   */
 
-  @Schema(name = "type", required = false)
+  @Schema(name = "type", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getType() {
     return type;
   }
@@ -81,7 +81,7 @@ public ModelApiResponse message(String message) {
    * @return message
   */
 
-  @Schema(name = "message", required = false)
+  @Schema(name = "message", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getMessage() {
     return message;
   }

diff --git a/...s/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Order.java b/...s/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Order.java
@@ -91,7 +91,7 @@ public Order id(Long id) {
    * @return id
   */
 
-  @Schema(name = "id", required = false)
+  @Schema(name = "id", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Long getId() {
     return id;
   }
@@ -110,7 +110,7 @@ public Order petId(Long petId) {
    * @return petId
   */
 
-  @Schema(name = "petId", required = false)
+  @Schema(name = "petId", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Long getPetId() {
     return petId;
   }
@@ -129,7 +129,7 @@ public Order quantity(Integer quantity) {
    * @return quantity
   */
 
-  @Schema(name = "quantity", required = false)
+  @Schema(name = "quantity", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Integer getQuantity() {
     return quantity;
   }
@@ -148,7 +148,7 @@ public Order shipDate(OffsetDateTime shipDate) {
    * @return shipDate
   */
   @Valid 
-  @Schema(name = "shipDate", required = false)
+  @Schema(name = "shipDate", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public OffsetDateTime getShipDate() {
     return shipDate;
   }
@@ -167,7 +167,7 @@ public Order status(StatusEnum status) {
    * @return status
   */
 
-  @Schema(name = "status", description = "Order Status", required = false)
+  @Schema(name = "status", description = "Order Status", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public StatusEnum getStatus() {
     return status;
   }
@@ -186,7 +186,7 @@ public Order complete(Boolean complete) {
    * @return complete
   */
 
-  @Schema(name = "complete", required = false)
+  @Schema(name = "complete", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Boolean getComplete() {
     return complete;
   }

diff --git a/...les/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Pet.java b/...les/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Pet.java
@@ -94,7 +94,7 @@ public Pet id(Long id) {
    * @return id
   */
 
-  @Schema(name = "id", required = false)
+  @Schema(name = "id", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Long getId() {
     return id;
   }
@@ -113,7 +113,7 @@ public Pet category(Category category) {
    * @return category
   */
   @Valid 
-  @Schema(name = "category", required = false)
+  @Schema(name = "category", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Category getCategory() {
     return category;
   }
@@ -132,7 +132,7 @@ public Pet name(String name) {
    * @return name
   */
   @NotNull 
-  @Schema(name = "name", example = "doggie", required = true)
+  @Schema(name = "name", example = "doggie", requiredMode = Schema.RequiredMode.REQUIRED)
   public String getName() {
     return name;
   }
@@ -156,7 +156,7 @@ public Pet addPhotoUrlsItem(String photoUrlsItem) {
    * @return photoUrls
   */
   @NotNull 
-  @Schema(name = "photoUrls", required = true)
+  @Schema(name = "photoUrls", requiredMode = Schema.RequiredMode.REQUIRED)
   public List<String> getPhotoUrls() {
     return photoUrls;
   }
@@ -183,7 +183,7 @@ public Pet addTagsItem(Tag tagsItem) {
    * @return tags
   */
   @Valid 
-  @Schema(name = "tags", required = false)
+  @Schema(name = "tags", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public List<Tag> getTags() {
     return tags;
   }
@@ -202,7 +202,7 @@ public Pet status(StatusEnum status) {
    * @return status
   */
 
-  @Schema(name = "status", description = "pet status in the store", required = false)
+  @Schema(name = "status", description = "pet status in the store", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public StatusEnum getStatus() {
     return status;
   }

diff --git a/...les/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Tag.java b/...les/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/Tag.java
@@ -38,7 +38,7 @@ public Tag id(Long id) {
    * @return id
   */
 
-  @Schema(name = "id", required = false)
+  @Schema(name = "id", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Long getId() {
     return id;
   }
@@ -57,7 +57,7 @@ public Tag name(String name) {
    * @return name
   */
 
-  @Schema(name = "name", required = false)
+  @Schema(name = "name", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getName() {
     return name;
   }

diff --git a/...es/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/User.java b/...es/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/model/User.java
@@ -56,7 +56,7 @@ public User id(Long id) {
    * @return id
   */
 
-  @Schema(name = "id", required = false)
+  @Schema(name = "id", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Long getId() {
     return id;
   }
@@ -75,7 +75,7 @@ public User username(String username) {
    * @return username
   */
 
-  @Schema(name = "username", required = false)
+  @Schema(name = "username", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getUsername() {
     return username;
   }
@@ -94,7 +94,7 @@ public User firstName(String firstName) {
    * @return firstName
   */
 
-  @Schema(name = "firstName", required = false)
+  @Schema(name = "firstName", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getFirstName() {
     return firstName;
   }
@@ -113,7 +113,7 @@ public User lastName(String lastName) {
    * @return lastName
   */
 
-  @Schema(name = "lastName", required = false)
+  @Schema(name = "lastName", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getLastName() {
     return lastName;
   }
@@ -132,7 +132,7 @@ public User email(String email) {
    * @return email
   */
 
-  @Schema(name = "email", required = false)
+  @Schema(name = "email", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getEmail() {
     return email;
   }
@@ -151,7 +151,7 @@ public User password(String password) {
    * @return password
   */
 
-  @Schema(name = "password", required = false)
+  @Schema(name = "password", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getPassword() {
     return password;
   }
@@ -170,7 +170,7 @@ public User phone(String phone) {
    * @return phone
   */
 
-  @Schema(name = "phone", required = false)
+  @Schema(name = "phone", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getPhone() {
     return phone;
   }
@@ -189,7 +189,7 @@ public User userStatus(Integer userStatus) {
    * @return userStatus
   */
 
-  @Schema(name = "userStatus", description = "User Status", required = false)
+  @Schema(name = "userStatus", description = "User Status", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Integer getUserStatus() {
     return userStatus;
   }

diff --git a/...pi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/model/Category.java b/...pi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/model/Category.java
@@ -38,7 +38,7 @@ public Category id(Long id) {
    * @return id
   */
 
-  @Schema(name = "id", required = false)
+  @Schema(name = "id", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Long getId() {
     return id;
   }
@@ -57,7 +57,7 @@ public Category name(String name) {
    * @return name
   */
 
-  @Schema(name = "name", required = false)
+  @Schema(name = "name", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getName() {
     return name;
   }

diff --git a/...nt/petstore/spring-cloud-async/src/main/java/org/openapitools/model/ModelApiResponse.java b/...nt/petstore/spring-cloud-async/src/main/java/org/openapitools/model/ModelApiResponse.java
@@ -43,7 +43,7 @@ public ModelApiResponse code(Integer code) {
    * @return code
   */
 
-  @Schema(name = "code", required = false)
+  @Schema(name = "code", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public Integer getCode() {
     return code;
   }
@@ -62,7 +62,7 @@ public ModelApiResponse type(String type) {
    * @return type
   */
 
-  @Schema(name = "type", required = false)
+  @Schema(name = "type", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getType() {
     return type;
   }
@@ -81,7 +81,7 @@ public ModelApiResponse message(String message) {
    * @return message
   */
 
-  @Schema(name = "message", required = false)
+  @Schema(name = "message", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
   public String getMessage() {
     return message;
   }