Changes report: upgrade to swagger-api 2.2.0 and swagger-ui 4.10.3

Author: bnasslahsen

pom.xml

@@ -61,7 +61,7 @@
 		<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
 		<maven-release-plugin.version>2.5.3</maven-release-plugin.version>
 		<nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
-		<swagger-api.version>2.1.13</swagger-api.version>
+		<swagger-api.version>2.2.0</swagger-api.version>
 		<swagger-ui.version>4.10.3</swagger-ui.version>
 		<classgraph.version>4.8.143</classgraph.version>
 		<webjars-locator-core.version>0.50</webjars-locator-core.version>

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocHints.java

@@ -31,13 +31,17 @@
 import io.swagger.v3.core.filter.SpecFilter;
 import io.swagger.v3.core.jackson.ApiResponsesSerializer;
 import io.swagger.v3.core.jackson.PathsSerializer;
+import io.swagger.v3.core.jackson.mixin.Components31Mixin;
 import io.swagger.v3.core.jackson.mixin.ComponentsMixin;
 import io.swagger.v3.core.jackson.mixin.DateSchemaMixin;
+import io.swagger.v3.core.jackson.mixin.Discriminator31Mixin;
 import io.swagger.v3.core.jackson.mixin.ExampleMixin;
 import io.swagger.v3.core.jackson.mixin.ExtensionsMixin;
 import io.swagger.v3.core.jackson.mixin.MediaTypeMixin;
+import io.swagger.v3.core.jackson.mixin.OpenAPI31Mixin;
 import io.swagger.v3.core.jackson.mixin.OpenAPIMixin;
 import io.swagger.v3.core.jackson.mixin.OperationMixin;
+import io.swagger.v3.core.jackson.mixin.Schema31Mixin;
 import io.swagger.v3.core.jackson.mixin.SchemaMixin;
 import io.swagger.v3.oas.annotations.ExternalDocumentation;
 import io.swagger.v3.oas.annotations.Hidden;
@@ -232,6 +236,10 @@
 		OpenAPIMixin.class,
 		OperationMixin.class,
 		SchemaMixin.class,
+		Schema31Mixin.class,
+		Components31Mixin.class,
+		OpenAPI31Mixin.class,
+		Discriminator31Mixin.class,
 		Paths.class,
 		XML.class,
 		UUIDSchema.class,

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/DataRestDelegatingMethodParameterCustomizer.java

@@ -371,6 +371,11 @@ public Class<?>[] subTypes() {
 						public Extension[] extensions() {
 							return parameter.schema().extensions();
 						}
+
+						@Override
+						public AdditionalPropertiesValue additionalProperties() {
+							return parameter.schema().additionalProperties();
+						}
 					};
 				}
 
@@ -587,6 +592,11 @@ public Class<?>[] subTypes() {
 								public Extension[] extensions() {
 									return schema.extensions();
 								}
+
+								@Override
+								public AdditionalPropertiesValue additionalProperties() {
+									return schema.additionalProperties();
+								}
 							};
 						}
 

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/fn/builders/apiresponse/Builder.java

@@ -80,6 +80,10 @@ public class Builder {
 	 */
 	private String ref = "";
 
+	/**
+	 * The Use return type schema.
+	 */
+	boolean useReturnTypeSchema = false;
 
 	/**
 	 * Instantiates a new Api response builder.
@@ -241,6 +245,11 @@ public Extension[] extensions() {
 			public String ref() {
 				return ref;
 			}
+
+			@Override
+			public boolean useReturnTypeSchema() {
+				return useReturnTypeSchema;
+			}
 		};
 	}
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/fn/builders/content/Builder.java

@@ -30,6 +30,7 @@
 import io.swagger.v3.oas.annotations.media.Encoding;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
 import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.media.SchemaProperty;
 import org.apache.commons.lang3.ArrayUtils;
 
 /**
@@ -75,6 +76,17 @@ public class Builder {
 	 */
 	private Extension[] extensions = {};
 
+	/**
+	 * The schema properties defined for schema provided in @Schema
+	 *
+	 */
+	private Schema additionalPropertiesSchema = org.springdoc.core.fn.builders.schema.Builder.schemaBuilder().build();
+
+	/**
+	 * The schema properties defined for schema provided in @Schema
+	 *
+	 */
+	private SchemaProperty[] schemaProperties = {};
 
 	/**
 	 * Instantiates a new Content builder.
@@ -185,6 +197,16 @@ public Schema schema() {
 				return schema;
 			}
 
+			@Override
+			public SchemaProperty[] schemaProperties() {
+				return schemaProperties;
+			}
+
+			@Override
+			public Schema additionalPropertiesSchema() {
+				return additionalPropertiesSchema;
+			}
+
 			@Override
 			public ArraySchema array() {
 				return array;

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/fn/builders/schema/Builder.java

@@ -29,6 +29,7 @@
 import io.swagger.v3.oas.annotations.media.DiscriminatorMapping;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.media.Schema.AccessMode;
+import io.swagger.v3.oas.annotations.media.Schema.AdditionalPropertiesValue;
 import org.apache.commons.lang3.ArrayUtils;
 
 /**
@@ -259,6 +260,16 @@ public class Builder {
 	 */
 	private Extension[] extensions = {};
 
+	/**
+	 * Allows to specify the additionalProperties value
+	 *
+	 * AdditionalPropertiesValue.TRUE: set to TRUE
+	 * AdditionalPropertiesValue.FALSE: set to FALSE
+	 * AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION: resolve from @Content.additionalPropertiesSchema
+	 *
+	 */
+	private AdditionalPropertiesValue additionalProperties = AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION;
+
 
 	/**
 	 * Instantiates a new Schema builder.
@@ -872,6 +883,11 @@ public Class<?>[] subTypes() {
 			public Extension[] extensions() {
 				return extensions;
 			}
+
+			@Override
+			public AdditionalPropertiesValue additionalProperties() {
+				return additionalProperties;
+			}
 		};
 	}
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/mixins/SortedSchemaMixin.java

@@ -22,18 +22,21 @@
 
 package org.springdoc.core.mixins;
 
+import java.math.BigDecimal;
 import java.util.Map;
+import java.util.Set;
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import io.swagger.v3.oas.models.media.Schema;
 
 /**
  * @author bnasslashen
  */
-@JsonPropertyOrder(value = {"type", "format"}, alphabetic = true)
+@JsonPropertyOrder(value = { "type", "format" }, alphabetic = true)
 public interface SortedSchemaMixin {
 
 	@JsonAnyGetter
@@ -49,4 +52,34 @@ public interface SortedSchemaMixin {
 	@JsonInclude(JsonInclude.Include.CUSTOM)
 	Object getExample();
 
+	@JsonIgnore
+	Map<String, Object> getJsonSchema();
+
+	@JsonIgnore
+	BigDecimal getExclusiveMinimumValue();
+
+	@JsonIgnore
+	BigDecimal getExclusiveMaximumValue();
+
+	@JsonIgnore
+	Map<String, Schema> getPatternProperties();
+
+	@JsonIgnore
+	Schema getContains();
+
+	@JsonIgnore
+	String get$id();
+
+	@JsonIgnore
+	String get$anchor();
+
+	@JsonIgnore
+	String get$schema();
+
+	@JsonIgnore
+	Set<String> getTypes();
+
+	@JsonIgnore
+	Object getJsonSchemaImpl();
+
 }