code review

bnasslahsen · bnasslahsen · commit c523445dbd92 · 2022-04-24T15:15:33.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java
@@ -369,11 +369,11 @@ private Schema calculateRequestBodySchema(Components components, ParameterInfo p
 		}
 
 		if (requestBodyInfo.getMergedSchema() != null) {
-			requestBodyInfo.getMergedSchema().addProperties(paramName, schemaN);
+			requestBodyInfo.getMergedSchema().addProperty(paramName, schemaN);
 			schemaN = requestBodyInfo.getMergedSchema();
 		}
 		else if (parameterInfo.isRequestPart() || schemaN instanceof FileSchema || schemaN instanceof ArraySchema && ((ArraySchema) schemaN).getItems() instanceof FileSchema) {
-			schemaN = new ObjectSchema().addProperties(paramName, schemaN);
+			schemaN = new ObjectSchema().addProperty(paramName, schemaN);
 			requestBodyInfo.setMergedSchema(schemaN);
 		}
 		else
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GroupedOpenApi.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GroupedOpenApi.java
@@ -472,7 +472,7 @@ public GroupedOpenApi build() {
 	 * @param openApiCustomizerCollection the open api customizer collection
 	 * @return the grouped open api
 	 */
-	public GroupedOpenApi addAllOpenApiCustomizer(Collection openApiCustomizerCollection) {
+	public GroupedOpenApi addAllOpenApiCustomizer(Collection<? extends OpenApiCustomiser> openApiCustomizerCollection) {
 		this.openApiCustomisers.addAll(openApiCustomizerCollection);
 		Collections.reverse(openApiCustomisers);
 		return this;
@@ -484,7 +484,7 @@ public GroupedOpenApi addAllOpenApiCustomizer(Collection openApiCustomizerCollec
 	 * @param operationCustomizerCollection the operation customizer collection
 	 * @return the grouped open api
 	 */
-	public GroupedOpenApi addAllOperationCustomizer(Collection operationCustomizerCollection) {
+	public GroupedOpenApi addAllOperationCustomizer(Collection<? extends OperationCustomizer> operationCustomizerCollection) {
 		this.operationCustomizers.addAll(operationCustomizerCollection);
 		Collections.reverse(operationCustomizers);
 		return this;
@@ -496,7 +496,7 @@ public GroupedOpenApi addAllOperationCustomizer(Collection operationCustomizerCo
 	 * @param openApiMethodFilterCollection the open api method filter collection
 	 * @return the grouped open api
 	 */
-	public GroupedOpenApi addAllOpenApiMethodFilter(Collection openApiMethodFilterCollection) {
+	public GroupedOpenApi addAllOpenApiMethodFilter(Collection<? extends OpenApiMethodFilter> openApiMethodFilterCollection) {
 		this.openApiMethodFilters.addAll(openApiMethodFilterCollection);
 		Collections.reverse(openApiMethodFilters);
 		return this;
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyInfo.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyInfo.java
@@ -88,7 +88,7 @@ public void setMergedSchema(Schema mergedSchema) {
 	public void addProperties(String paramName, Schema schemaN) {
 		if (mergedSchema == null)
 			mergedSchema = new ObjectSchema();
-		mergedSchema.addProperties(paramName, schemaN);
+		mergedSchema.addProperty(paramName, schemaN);
 	}
 
 }
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SecurityService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SecurityService.java
@@ -106,8 +106,7 @@ else if (!StringUtils.isBlank(oAuthFlow.authorizationUrl()) || !StringUtils.isBl
 	 * @return the boolean
 	 */
 	private static boolean isEmpty(OAuthScope[] scopes) {
-		boolean result = scopes == null || scopes.length == 0;
-		return result;
+		return scopes == null || scopes.length == 0;
 	}
 
 	/**
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/GlobalOpenApiCustomizer.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/GlobalOpenApiCustomizer.java
@@ -27,7 +27,7 @@
  * customize Open api on default OpenAPI description and groups.
  *
  * @author christophejan
- * @see  OpenApiCustomiserto customize default OpenAPI description but not      groups
+ * @see  OpenApiCustomiser customize default OpenAPI description but not      groups
  */
 public interface GlobalOpenApiCustomizer extends OpenApiCustomiser {
 }
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/fn/builders/schema/Builder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/fn/builders/schema/Builder.java
@@ -268,7 +268,7 @@ public class Builder {
 	 * AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION: resolve from @Content.additionalPropertiesSchema
 	 *
 	 */
-	private final AdditionalPropertiesValue additionalProperties = AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION;
+	private AdditionalPropertiesValue additionalProperties = AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION;
 
 	/**
 	 * Instantiates a new Schema builder.
@@ -681,6 +681,17 @@ public Builder extensions(org.springdoc.core.fn.builders.extension.Builder exten
 		return this;
 	}
 
+	/**
+	 * Additional properties builder.
+	 *
+	 * @param additionalProperties the additional properties
+	 * @return the builder
+	 */
+	public Builder additionalProperties(AdditionalPropertiesValue additionalProperties) {
+		this.additionalProperties = additionalProperties;
+		return this;
+	}
+
 	/**
 	 * Build schema.
 	 *
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/providers/ObjectMapperProvider.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/providers/ObjectMapperProvider.java
@@ -45,19 +45,12 @@ public class ObjectMapperProvider {
 	 */
 	private final ObjectMapper yamlMapper;
 
-	/**
-	 * The Spring doc config properties.
-	 */
-	private final SpringDocConfigProperties springDocConfigProperties;
-
-
 	/**
 	 * Instantiates a new Spring doc object mapper.
 	 *
 	 * @param springDocConfigProperties the spring doc config properties
 	 */
 	public ObjectMapperProvider(SpringDocConfigProperties springDocConfigProperties) {
-		this.springDocConfigProperties = springDocConfigProperties;
 		OpenApiVersion openApiVersion = springDocConfigProperties.getApiDocs().getVersion();
 		if (openApiVersion == OpenApiVersion.OPENAPI_3_1) {
 			jsonMapper = Json31.mapper();
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/DataRestHalProvider.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/DataRestHalProvider.java
@@ -44,11 +44,6 @@ public class DataRestHalProvider extends HateoasHalProvider {
 	 */
 	private final Optional<RepositoryRestConfiguration> repositoryRestConfigurationOptional;
 
-	/**
-	 * The Object mapper provider.
-	 */
-	private final ObjectMapperProvider objectMapperProvider;
-
 	/**
 	 * Instantiates a new Data rest hal provider.
 	 *
@@ -60,7 +55,6 @@ public DataRestHalProvider(Optional<RepositoryRestConfiguration> repositoryRestC
 			ObjectMapperProvider objectMapperProvider) {
 		super(hateoasPropertiesOptional, objectMapperProvider);
 		this.repositoryRestConfigurationOptional = repositoryRestConfigurationOptional;
-		this.objectMapperProvider = objectMapperProvider;
 	}
 
 	@PostConstruct
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestResponseService.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestResponseService.java
@@ -262,8 +262,7 @@ else if (parameterizedType.getActualTypeArguments()[0] instanceof ParameterizedT
 			return getTypeForParameterizedType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);
 		}
 		else if (parameterizedType.getActualTypeArguments()[0] instanceof WildcardType) {
-			Type type = getTypeForWildcardType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);
-			return type;
+			return getTypeForWildcardType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);
 		}
 		return null;
 	}
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/customisers/QuerydslPredicateOperationCustomizer.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/customisers/QuerydslPredicateOperationCustomizer.java
@@ -45,7 +45,7 @@
 import org.apache.commons.lang3.reflect.FieldUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springdoc.core.customizers.OperationCustomizer;
+import org.springdoc.core.customizers.GlobalOperationCustomizer;
 
 import org.springframework.core.MethodParameter;
 import org.springframework.data.querydsl.binding.QuerydslBinderCustomizer;
@@ -63,7 +63,7 @@
  * @author Gibah Joseph Email: gibahjoe@gmail.com Mar, 2020
  */
 @SuppressWarnings("unchecked")
-public class QuerydslPredicateOperationCustomizer implements OperationCustomizer {
+public class QuerydslPredicateOperationCustomizer implements GlobalOperationCustomizer {
 
 	/**
 	 * The constant LOGGER.
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/utils/SpringDocDataRestUtils.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/utils/SpringDocDataRestUtils.java
@@ -235,9 +235,9 @@ private void updateRequestBodySchemaProperties(String key, Schema referencedSche
 				String propId = entry.getKey();
 				if (entityInoMap.containsKey(key) && entityInoMap.get(key).getAssociationsFields().contains(propId)) {
 					if (entry.getValue() instanceof ArraySchema)
-						referencedSchema.addProperties(propId, new ArraySchema().items(new StringSchema()));
+						referencedSchema.addProperty(propId, new ArraySchema().items(new StringSchema()));
 					else
-						referencedSchema.addProperties(propId, new StringSchema());
+						referencedSchema.addProperty(propId, new StringSchema());
 				}
 			}
 		}
diff --git a/springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/HateoasHalProvider.java b/springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/HateoasHalProvider.java
@@ -45,7 +45,7 @@ public class HateoasHalProvider {
 	/**
 	 * The Object mapper provider.
 	 */
-	private final ObjectMapperProvider objectMapperProvider;
+	protected final ObjectMapperProvider objectMapperProvider;
 
 	/**
 	 * Instantiates a new Hateoas hal provider.
diff --git a/springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/SpringDocHateoasConfiguration.java b/springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/SpringDocHateoasConfiguration.java
@@ -27,7 +27,7 @@
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import org.springdoc.core.SpringDocConfigProperties;
-import org.springdoc.core.customizers.OpenApiCustomiser;
+import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
 import org.springdoc.core.providers.ObjectMapperProvider;
 import org.springdoc.hateoas.converters.CollectionModelContentConverter;
 import org.springdoc.hateoas.converters.OpenApiHateoasLinksCustomiser;
@@ -98,7 +98,7 @@ CollectionModelContentConverter collectionModelContentConverter(HateoasHalProvid
 	@Bean(LINKS_SCHEMA_CUSTOMISER)
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	OpenApiCustomiser linksSchemaCustomiser(HateoasHalProvider halProvider, SpringDocConfigProperties springDocConfigProperties, ObjectMapperProvider objectMapperProvider) {
+	GlobalOpenApiCustomizer linksSchemaCustomiser(HateoasHalProvider halProvider, SpringDocConfigProperties springDocConfigProperties, ObjectMapperProvider objectMapperProvider) {
 		if (!halProvider.isHalEnabled()) {
 			return openApi -> {
 			};
diff --git a/springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/converters/OpenApiHateoasLinksCustomiser.java b/springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/converters/OpenApiHateoasLinksCustomiser.java
@@ -32,15 +32,15 @@
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import org.springdoc.core.SpringDocConfigProperties;
-import org.springdoc.core.customizers.OpenApiCustomiser;
+import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
 
 import org.springframework.hateoas.Link;
 
 /**
  * The type Open api hateoas links customiser.
  * @author bnasslahsen
  */
-public class OpenApiHateoasLinksCustomiser extends SpecFilter implements OpenApiCustomiser {
+public class OpenApiHateoasLinksCustomiser extends SpecFilter implements GlobalOpenApiCustomizer {
 
 	/**
 	 * The Spring doc config properties.
diff --git a/springdoc-openapi-kotlin/src/main/java/org/springdoc/kotlin/SpringDocKotlinConfiguration.java b/springdoc-openapi-kotlin/src/main/java/org/springdoc/kotlin/SpringDocKotlinConfiguration.java
@@ -45,21 +45,15 @@
 @ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
 public class SpringDocKotlinConfiguration {
 
-	/**
-	 * The Object mapper provider.
-	 */
-	private final ObjectMapperProvider objectMapperProvider;
-
 	/**
 	 * Instantiates a new Spring doc kotlin configuration.
 	 *
 	 * @param objectMapperProvider the object mapper provider
 	 */
 	public SpringDocKotlinConfiguration(ObjectMapperProvider objectMapperProvider) {
-		this.objectMapperProvider = objectMapperProvider;
 		getConfig().addRequestWrapperToIgnore(Continuation.class)
 				.addDeprecatedType(Deprecated.class);
-		objectMapperProvider.jsonMapper().registerModule(new KotlinModule());
+		objectMapperProvider.jsonMapper().registerModule( new KotlinModule.Builder().build());
 	}
 
 	/**
diff --git a/springdoc-openapi-security/src/main/java/org/springdoc/security/SpringDocSecurityConfiguration.java b/springdoc-openapi-security/src/main/java/org/springdoc/security/SpringDocSecurityConfiguration.java
@@ -134,8 +134,8 @@ OpenApiCustomiser springSecurityLoginEndpointCustomiser(ApplicationContext appli
 						UsernamePasswordAuthenticationFilter usernamePasswordAuthenticationFilter = optionalFilter.get();
 						Operation operation = new Operation();
 						Schema<?> schema = new ObjectSchema()
-								.addProperties(usernamePasswordAuthenticationFilter.getUsernameParameter(), new StringSchema())
-								.addProperties(usernamePasswordAuthenticationFilter.getPasswordParameter(), new StringSchema());
+								.addProperty(usernamePasswordAuthenticationFilter.getUsernameParameter(), new StringSchema())
+								.addProperty(usernamePasswordAuthenticationFilter.getPasswordParameter(), new StringSchema());
 						RequestBody requestBody = new RequestBody().content(new Content().addMediaType(org.springframework.http.MediaType.APPLICATION_JSON_VALUE, new MediaType().schema(schema)));
 						operation.requestBody(requestBody);
 						ApiResponses apiResponses = new ApiResponses();

Original file line number	Diff line number	Diff line change
`@@ -369,11 +369,11 @@ private Schema calculateRequestBodySchema(Components components, ParameterInfo p`
`369`	`369`	`}`
`370`	`370`
`371`	`371`	`if (requestBodyInfo.getMergedSchema() != null) {`
`372`		`- requestBodyInfo.getMergedSchema().addProperties(paramName, schemaN);`
	`372`	`+ requestBodyInfo.getMergedSchema().addProperty(paramName, schemaN);`
`373`	`373`	`schemaN = requestBodyInfo.getMergedSchema();`
`374`	`374`	`}`
`375`	`375`	`else if (parameterInfo.isRequestPart() \|\| schemaN instanceof FileSchema \|\| schemaN instanceof ArraySchema && ((ArraySchema) schemaN).getItems() instanceof FileSchema) {`
`376`		`- schemaN = new ObjectSchema().addProperties(paramName, schemaN);`
	`376`	`+ schemaN = new ObjectSchema().addProperty(paramName, schemaN);`
`377`	`377`	`requestBodyInfo.setMergedSchema(schemaN);`
`378`	`378`	`}`
`379`	`379`	`else`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public void setMergedSchema(Schema mergedSchema) {`
`88`	`88`	`public void addProperties(String paramName, Schema schemaN) {`
`89`	`89`	`if (mergedSchema == null)`
`90`	`90`	`mergedSchema = new ObjectSchema();`
`91`		`- mergedSchema.addProperties(paramName, schemaN);`
	`91`	`+ mergedSchema.addProperty(paramName, schemaN);`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -106,8 +106,7 @@ else if (!StringUtils.isBlank(oAuthFlow.authorizationUrl()) \|\| !StringUtils.isBl`
`106`	`106`	`* @return the boolean`
`107`	`107`	`*/`
`108`	`108`	`private static boolean isEmpty(OAuthScope[] scopes) {`
`109`		`- boolean result = scopes == null \|\| scopes.length == 0;`
`110`		`- return result;`
	`109`	`+ return scopes == null \|\| scopes.length == 0;`
`111`	`110`	`}`
`112`	`111`
`113`	`112`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* customize Open api on default OpenAPI description and groups.`
`28`	`28`	`*`
`29`	`29`	`* @author christophejan`
`30`		`- * @see OpenApiCustomiserto customize default OpenAPI description but not groups`
	`30`	`+ * @see OpenApiCustomiser customize default OpenAPI description but not groups`
`31`	`31`	`*/`
`32`	`32`	`public interface GlobalOpenApiCustomizer extends OpenApiCustomiser {`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -262,8 +262,7 @@ else if (parameterizedType.getActualTypeArguments()[0] instanceof ParameterizedT`
`262`	`262`	`return getTypeForParameterizedType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);`
`263`	`263`	`}`
`264`	`264`	`else if (parameterizedType.getActualTypeArguments()[0] instanceof WildcardType) {`
`265`		`- Type type = getTypeForWildcardType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);`
`266`		`- return type;`
	`265`	`+ return getTypeForWildcardType(requestMethod, dataRestRepository, returnedEntityType, parameterizedType);`
`267`	`266`	`}`
`268`	`267`	`return null;`
`269`	`268`	`}`