Merge remote-tracking branch 'origin/master' into used-merged-annotation-for-parameter

Author: jryan128

README.md

@@ -48,9 +48,10 @@ This is a community-based project, not maintained by the Spring Framework Contri
 springdoc.swagger-ui.path=/swagger-ui.html
 ```
 
-## [Demo Spring Boot 2 webmvc with OpenAPI 3](https://springdoc-openapi-test-app2-silly-numbat.eu-de.mybluemix.net/).
-## [Demo Spring Boot 1 webmvc with OpenAPI 3](https://springdoc-openapi-test-app1-courteous-puku.eu-de.mybluemix.net/).
-## [Demo Spring Boot 2 webflux with OpenAPI 3](https://springdoc-openapi-test-app3-terrific-rabbit.eu-de.mybluemix.net/swagger-ui.html).
+## [Demo Spring Boot 2 Web MVC with OpenAPI 3](https://springdoc-openapi-test-app2-rested-ardvark.eu-de.mybluemix.net/).
+## [Demo Spring Boot 2 WebFlux with OpenAPI 3](https://springdoc-openapi-test-app3-generous-springhare.eu-de.mybluemix.net/swagger-ui.html).
+## [Demo Spring Boot 1 Web MVC with OpenAPI 3](https://springdoc-openapi-test-app1-exhausted-civet.eu-de.mybluemix.net/).
+## [Demo Spring Boot 2 WebFlux with Functional endpoints OpenAPI 3](https://springdoc-openapi-test-app4-happy-ostrich.eu-de.mybluemix.net/swagger-ui.html).
 
 ![Branching](https://springdoc.org/assets/images/pets.png)
 

pom.xml

@@ -13,7 +13,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>2.2.6.RELEASE</version>
+		<version>2.3.0.RELEASE</version>
 	</parent>
 
 	<licenses>
@@ -26,7 +26,7 @@
 	<developers>
 		<developer>
 			<name>Badr NASS</name>
-			<email>[email protected]</email>
+			<email>[email protected]</email>
 			<organization>BADR</organization>
 			<organizationUrl>https://springdoc.github.io/springdoc-openapi/
 			</organizationUrl>
@@ -61,6 +61,7 @@
 		<module>springdoc-openapi-data-rest</module>
 		<module>springdoc-openapi-security</module>
 		<module>springdoc-openapi-groovy</module>
+		<module>springdoc-openapi-hateoas</module>
 	</modules>
 
 	<properties>
@@ -72,7 +73,7 @@
 		<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.2</swagger-api.version>
-		<swagger-ui.version>3.25.2</swagger-ui.version>
+		<swagger-ui.version>3.25.3</swagger-ui.version>
 		<spring-security-oauth2.version>2.3.8.RELEASE</spring-security-oauth2.version>
 		<classgraph.version>4.8.44</classgraph.version>
 	</properties>

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -67,9 +67,9 @@
 import org.springdoc.core.annotations.RouterOperations;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.OperationCustomizer;
-import org.springdoc.core.models.RouterFunctionData;
-import org.springdoc.core.models.RouterOperation;
-import org.springdoc.core.visitor.AbstractRouterFunctionVisitor;
+import org.springdoc.core.fn.AbstractRouterFunctionVisitor;
+import org.springdoc.core.fn.RouterFunctionData;
+import org.springdoc.core.fn.RouterOperation;
 
 import org.springframework.context.ApplicationContext;
 import org.springframework.core.annotation.AnnotatedElementUtils;
@@ -346,9 +346,9 @@ protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVis
 		else
 			routerOperationList.addAll(Arrays.asList(routerOperations.value()));
 		if (routerOperationList.size() == 1)
-			calculatePath(routerOperationList.stream().map(routerOperation -> new org.springdoc.core.models.RouterOperation(routerOperation, routerFunctionVisitor.getRouterFunctionDatas().get(0))).collect(Collectors.toList()));
+			calculatePath(routerOperationList.stream().map(routerOperation -> new RouterOperation(routerOperation, routerFunctionVisitor.getRouterFunctionDatas().get(0))).collect(Collectors.toList()));
 		else {
-			List<org.springdoc.core.models.RouterOperation> operationList = routerOperationList.stream().map(org.springdoc.core.models.RouterOperation::new).collect(Collectors.toList());
+			List<RouterOperation> operationList = routerOperationList.stream().map(RouterOperation::new).collect(Collectors.toList());
 			mergeRouters(routerFunctionVisitor.getRouterFunctionDatas(), operationList);
 			calculatePath(operationList);
 		}
@@ -426,8 +426,8 @@ protected Operation customiseOperation(Operation operation, HandlerMethod handle
 		return operation;
 	}
 
-	protected void mergeRouters(List<RouterFunctionData> routerFunctionDatas, List<org.springdoc.core.models.RouterOperation> routerOperationList) {
-		for (org.springdoc.core.models.RouterOperation routerOperation : routerOperationList) {
+	protected void mergeRouters(List<RouterFunctionData> routerFunctionDatas, List<RouterOperation> routerOperationList) {
+		for (RouterOperation routerOperation : routerOperationList) {
 			if (StringUtils.isNotBlank(routerOperation.getPath())) {
 				// PATH
 				List<RouterFunctionData> routerFunctionDataList = routerFunctionDatas.stream()
@@ -565,7 +565,7 @@ private void fillParametersList(Operation operation, Map<String, String> queryPa
 		}
 	}
 
-	private void fillRouterOperation(RouterFunctionData routerFunctionData, org.springdoc.core.models.RouterOperation routerOperation) {
+	private void fillRouterOperation(RouterFunctionData routerFunctionData, RouterOperation routerOperation) {
 		if (ArrayUtils.isEmpty(routerOperation.getConsumes()))
 			routerOperation.setConsumes(routerFunctionData.getConsumes());
 		if (ArrayUtils.isEmpty(routerOperation.getProduces()))

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java

@@ -221,6 +221,17 @@ Schema calculateSchema(Components components, ParameterInfo parameterInfo, Reque
 			schemaN = parameterInfo.getParameterModel().getSchema();
 
 		if (requestBodyInfo != null) {
+			if (schemaN != null && StringUtils.isEmpty(schemaN.getDescription()) && parameterInfo.getParameterModel() != null) {
+				String description = parameterInfo.getParameterModel().getDescription();
+				if (schemaN.get$ref() != null && schemaN.get$ref().contains(AnnotationsUtils.COMPONENTS_REF)) {
+					String key = schemaN.get$ref().substring(21);
+					Schema existingSchema = components.getSchemas().get(key);
+					existingSchema.setDescription(description);
+				}
+				else
+					schemaN.setDescription(description);
+			}
+
 			if (requestBodyInfo.getMergedSchema() != null) {
 				requestBodyInfo.getMergedSchema().addProperties(paramName, schemaN);
 				schemaN = requestBodyInfo.getMergedSchema();

springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyBuilder.java

@@ -156,22 +156,17 @@ public void calculateRequestBodyInfo(Components components, MethodAttributes met
 	private RequestBody buildRequestBody(RequestBody requestBody, Components components,
 			MethodAttributes methodAttributes,
 			ParameterInfo parameterInfo, RequestBodyInfo requestBodyInfo) {
-		if (requestBody == null)
+		if (requestBody == null) {
 			requestBody = new RequestBody();
-
-		if (parameterInfo.getParameterModel() != null) {
-			io.swagger.v3.oas.models.parameters.Parameter parameter = parameterInfo.getParameterModel();
-			if (StringUtils.isNotBlank(parameter.getDescription()))
-				requestBody.setDescription(parameter.getDescription());
-			requestBody.setRequired(parameter.getRequired());
+			requestBodyInfo.setRequestBody(requestBody);
 		}
 
 		if (requestBody.getContent() == null) {
 			Schema<?> schema = parameterBuilder.calculateSchema(components, parameterInfo, requestBodyInfo,
 					methodAttributes.getJsonViewAnnotationForRequestBody());
 			buildContent(requestBody, methodAttributes, schema);
 		}
-		else if (requestBodyInfo.getRequestBody() != null) {
+		else {
 			Schema<?> schema = parameterBuilder.calculateSchema(components, parameterInfo, requestBodyInfo,
 					methodAttributes.getJsonViewAnnotationForRequestBody());
 			mergeContent(requestBody, methodAttributes, schema);

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/PolymorphicModelConverter.java

@@ -30,6 +30,7 @@
 import io.swagger.v3.core.converter.AnnotatedType;
 import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.core.converter.ModelConverterContext;
+import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.core.util.Json;
 import io.swagger.v3.oas.models.media.ComposedSchema;
 import io.swagger.v3.oas.models.media.Schema;
@@ -52,7 +53,7 @@ private Schema composePolymorphicSchema(AnnotatedType type, Schema schema, Colle
 				.map(s -> (ComposedSchema) s)
 				.filter(s -> s.getAllOf() != null)
 				.filter(s -> s.getAllOf().stream().anyMatch(s2 -> ref.equals(s2.get$ref())))
-				.map(s -> new Schema().$ref("#/components/schemas/" + s.getName()))
+				.map(s -> new Schema().$ref(AnnotationsUtils.COMPONENTS_REF + s.getName()))
 				.collect(Collectors.toList());
 		if (composedSchemas.isEmpty()) return schema;
 

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/MonetaryAmount.java renamed to springdoc-openapi-common/src/main/java/org/springdoc/core/converters/models/MonetaryAmount.java

@@ -18,7 +18,7 @@
  *
  */
 
-package org.springdoc.core.converters;
+package org.springdoc.core.converters.models;
 
 import java.math.BigDecimal;
 

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/Pageable.java renamed to springdoc-openapi-common/src/main/java/org/springdoc/core/converters/models/Pageable.java

@@ -18,7 +18,7 @@
  *
  */
 
-package org.springdoc.data.rest.converters;
+package org.springdoc.core.converters.models;
 
 import java.util.List;
 import java.util.Objects;

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/PageableAsQueryParam.java renamed to springdoc-openapi-common/src/main/java/org/springdoc/core/converters/models/PageableAsQueryParam.java

@@ -18,7 +18,7 @@
  *
  */
 
-package org.springdoc.data.rest.converters;
+package org.springdoc.core.converters.models;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;

springdoc-openapi-common/src/main/java/org/springdoc/core/visitor/AbstractRouterFunctionVisitor.java renamed to springdoc-openapi-common/src/main/java/org/springdoc/core/fn/AbstractRouterFunctionVisitor.java

@@ -18,14 +18,12 @@
  *
  */
 
-package org.springdoc.core.visitor;
+package org.springdoc.core.fn;
 
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
 
-import org.springdoc.core.models.RouterFunctionData;
-
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;