Spring Data Rest: Wrong schema for request body in association controllers. Fixes #1082

bnasslahsen · bnasslahsen · commit 259260024819 · 2021-03-02T22:47:11.000+01:00
diff --git a/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestRequestService.java b/springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestRequestService.java
@@ -34,6 +34,7 @@
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.media.Content;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import io.swagger.v3.oas.models.parameters.Parameter;
@@ -59,6 +60,8 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
 
+import static org.springdoc.data.rest.utils.SpringDocDataRestUtils.buildTextUriContent;
+
 /**
  * The type Data rest request builder.
  * @author bnasslahsen
@@ -216,6 +219,8 @@ else if (!RequestMethod.GET.equals(requestMethod)) {
 					parameterInfo, requestBodyInfo);
 			requestBuilder.applyBeanValidatorAnnotations(requestBodyInfo.getRequestBody(), parameterAnnotations, methodParameter.isOptional());
 			operation.setRequestBody(requestBodyInfo.getRequestBody());
+			Content content = operation.getRequestBody().getContent();
+			buildTextUriContent(content);
 			operation.getRequestBody().setRequired(true);
 		}
 	}
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
@@ -35,8 +35,6 @@
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.Content;
-import io.swagger.v3.oas.models.media.MediaType;
-import io.swagger.v3.oas.models.media.StringSchema;
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import org.springdoc.core.GenericResponseService;
@@ -47,7 +45,6 @@
 import org.springframework.core.ResolvableType;
 import org.springframework.data.rest.core.mapping.MethodResourceMapping;
 import org.springframework.data.rest.core.mapping.ResourceMetadata;
-import org.springframework.data.rest.webmvc.RestMediaTypes;
 import org.springframework.hateoas.CollectionModel;
 import org.springframework.hateoas.EntityModel;
 import org.springframework.hateoas.Link;
@@ -61,6 +58,10 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
 
+import static org.springdoc.data.rest.utils.SpringDocDataRestUtils.buildTextUriContent;
+
+;
+
 /**
  * The type Data rest response builder.
  * @author bnasslahsen
@@ -138,8 +139,7 @@ public void buildEntityResponse(Operation operation, HandlerMethod handlerMethod
 		ApiResponses apiResponses = new ApiResponses();
 		ApiResponse apiResponse = new ApiResponse();
 		Content content = genericResponseService.buildContent(openAPI.getComponents(), methodParameterReturn.getParameterAnnotations(), methodAttributes.getMethodProduces(), null, returnType);
-		if (content.get(RestMediaTypes.TEXT_URI_LIST_VALUE) != null)
-			content.put(RestMediaTypes.TEXT_URI_LIST_VALUE, new MediaType().schema(new StringSchema()));
+		buildTextUriContent(content);
 		apiResponse.setContent(content);
 		addResponse(requestMethod, operationPath, apiResponses, apiResponse);
 		operation.setResponses(apiResponses);
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
@@ -0,0 +1,24 @@
+package org.springdoc.data.rest.utils;
+
+import io.swagger.v3.oas.models.media.Content;
+import io.swagger.v3.oas.models.media.MediaType;
+import io.swagger.v3.oas.models.media.StringSchema;
+
+import org.springframework.data.rest.webmvc.RestMediaTypes;
+
+/**
+ * The interface Spring doc data rest utils.
+ * @author bnasslashen
+ */
+public interface SpringDocDataRestUtils {
+
+	/**
+	 * Build text uri content.
+	 *
+	 * @param content the content
+	 */
+	static void buildTextUriContent(Content content) {
+		if (content.get(RestMediaTypes.TEXT_URI_LIST_VALUE) != null)
+			content.put(RestMediaTypes.TEXT_URI_LIST_VALUE, new MediaType().schema(new StringSchema()));
+	}
+}
diff --git a/springdoc-openapi-data-rest/src/test/resources/results/app10.json b/springdoc-openapi-data-rest/src/test/resources/results/app10.json
@@ -324,7 +324,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },
@@ -411,7 +411,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },
diff --git a/springdoc-openapi-data-rest/src/test/resources/results/app16.json b/springdoc-openapi-data-rest/src/test/resources/results/app16.json
@@ -369,7 +369,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },
@@ -466,7 +466,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },
diff --git a/springdoc-openapi-data-rest/src/test/resources/results/app17.json b/springdoc-openapi-data-rest/src/test/resources/results/app17.json
@@ -657,7 +657,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },
@@ -744,7 +744,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },
diff --git a/springdoc-openapi-data-rest/src/test/resources/results/app23.json b/springdoc-openapi-data-rest/src/test/resources/results/app23.json
@@ -505,7 +505,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },
@@ -592,7 +592,7 @@
             },
             "text/uri-list": {
               "schema": {
-                "$ref": "#/components/schemas/CollectionModelObject"
+                "type": "string"
               }
             }
           },

Original file line number	Diff line number	Diff line change
`@@ -324,7 +324,7 @@`
`324`	`324`	`},`
`325`	`325`	`"text/uri-list": {`
`326`	`326`	`"schema": {`
`327`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`327`	`+ "type": "string"`
`328`	`328`	`}`
`329`	`329`	`}`
`330`	`330`	`},`
`@@ -411,7 +411,7 @@`
`411`	`411`	`},`
`412`	`412`	`"text/uri-list": {`
`413`	`413`	`"schema": {`
`414`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`414`	`+ "type": "string"`
`415`	`415`	`}`
`416`	`416`	`}`
`417`	`417`	`},`
Original file line number	Diff line number	Diff line change
`@@ -369,7 +369,7 @@`
`369`	`369`	`},`
`370`	`370`	`"text/uri-list": {`
`371`	`371`	`"schema": {`
`372`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`372`	`+ "type": "string"`
`373`	`373`	`}`
`374`	`374`	`}`
`375`	`375`	`},`
`@@ -466,7 +466,7 @@`
`466`	`466`	`},`
`467`	`467`	`"text/uri-list": {`
`468`	`468`	`"schema": {`
`469`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`469`	`+ "type": "string"`
`470`	`470`	`}`
`471`	`471`	`}`
`472`	`472`	`},`
Original file line number	Diff line number	Diff line change
`@@ -657,7 +657,7 @@`
`657`	`657`	`},`
`658`	`658`	`"text/uri-list": {`
`659`	`659`	`"schema": {`
`660`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`660`	`+ "type": "string"`
`661`	`661`	`}`
`662`	`662`	`}`
`663`	`663`	`},`
`@@ -744,7 +744,7 @@`
`744`	`744`	`},`
`745`	`745`	`"text/uri-list": {`
`746`	`746`	`"schema": {`
`747`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`747`	`+ "type": "string"`
`748`	`748`	`}`
`749`	`749`	`}`
`750`	`750`	`},`
Original file line number	Diff line number	Diff line change
`@@ -505,7 +505,7 @@`
`505`	`505`	`},`
`506`	`506`	`"text/uri-list": {`
`507`	`507`	`"schema": {`
`508`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`508`	`+ "type": "string"`
`509`	`509`	`}`
`510`	`510`	`}`
`511`	`511`	`},`
`@@ -592,7 +592,7 @@`
`592`	`592`	`},`
`593`	`593`	`"text/uri-list": {`
`594`	`594`	`"schema": {`
`595`		`- "$ref": "#/components/schemas/CollectionModelObject"`
	`595`	`+ "type": "string"`
`596`	`596`	`}`
`597`	`597`	`}`
`598`	`598`	`},`