Unexpected fields in request body definition for RepresentationModel DTO (HATEOAS). fixes #725

Author: bnasslahsen

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

@@ -52,6 +52,11 @@ public class MethodAttributes {
 	 */
 	private boolean withApiResponseDoc;
 
+	/**
+	 * The With response body schema doc.
+	 */
+	private boolean withResponseBodySchemaDoc;
+
 	/**
 	 * The Json view annotation.
 	 */
@@ -386,4 +391,21 @@ public Map<String, ApiResponse> getGenericMapResponse() {
 		return genericMapResponse;
 	}
 
+	/**
+	 * Is with response body schema doc boolean.
+	 *
+	 * @return the boolean
+	 */
+	public boolean isWithResponseBodySchemaDoc() {
+		return withResponseBodySchemaDoc;
+	}
+
+	/**
+	 * Sets with response body schema doc.
+	 *
+	 * @param withResponseBodySchemaDoc the with response body schema doc
+	 */
+	public void setWithResponseBodySchemaDoc(boolean withResponseBodySchemaDoc) {
+		this.withResponseBodySchemaDoc = withResponseBodySchemaDoc;
+	}
 }

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

@@ -127,8 +127,14 @@ private void buildResquestBodyContent(io.swagger.v3.oas.annotations.parameters.R
 		Optional<Content> optionalContent = AnnotationsUtils
 				.getContent(requestBody.content(), getConsumes(classConsumes),
 						getConsumes(methodConsumes), null, components, jsonViewAnnotation);
-		if (requestBodyOp == null)
-			optionalContent.ifPresent(requestBodyObject::setContent);
+		if (requestBodyOp == null) {
+			if (optionalContent.isPresent()) {
+				Content content = optionalContent.get();
+				requestBodyObject.setContent(content);
+				if (containsResponseBodySchema(content))
+					methodAttributes.setWithResponseBodySchemaDoc(true);
+			}
+		}
 		else {
 			Content existingContent = requestBodyOp.getContent();
 			if (optionalContent.isPresent() && existingContent != null) {
@@ -146,6 +152,10 @@ private void buildResquestBodyContent(io.swagger.v3.oas.annotations.parameters.R
 		}
 	}
 
+	private boolean containsResponseBodySchema(Content content) {
+		return content.entrySet().stream().anyMatch(stringMediaTypeEntry -> stringMediaTypeEntry.getValue().getSchema() != null);
+	}
+
 	/**
 	 * Get consumes string [ ].
 	 *
@@ -254,7 +264,7 @@ private RequestBody buildRequestBody(RequestBody requestBody, Components compone
 					methodAttributes.getJsonViewAnnotationForRequestBody());
 			buildContent(requestBody, methodAttributes, schema);
 		}
-		else {
+		else if (!methodAttributes.isWithResponseBodySchemaDoc()) {
 			Schema<?> schema = parameterBuilder.calculateSchema(components, parameterInfo, requestBodyInfo,
 					methodAttributes.getJsonViewAnnotationForRequestBody());
 			mergeContent(requestBody, methodAttributes, schema);

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app5/SpringDocApp5Test.java

@@ -0,0 +1,43 @@
+/*
+ *
+ *  * Copyright 2019-2020 the original author or authors.
+ *  *
+ *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package test.org.springdoc.api.app5;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.media.StringSchema;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+
+public class SpringDocApp5Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {
+		@Bean
+		public OpenAPI customOpenAPI() {
+			return new OpenAPI().components(new Components()
+					.addSchemas("CompanyDtoNew",new Schema().addProperties("id", new StringSchema().format("uuid"
+					)).addProperties("name", new StringSchema())));
+		}
+	}
+
+
+}

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app5/controller/CompanyController.java

@@ -0,0 +1,34 @@
+package test.org.springdoc.api.app5.controller;
+
+import javax.validation.Valid;
+
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.RequiredArgsConstructor;
+import test.org.springdoc.api.app5.entities.CompanyDto;
+
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * @author Davide Pedone
+ * 2020
+ */
+@RestController
+@RequiredArgsConstructor
+public class CompanyController {
+
+
+	@PostMapping
+	@io.swagger.v3.oas.annotations.parameters.RequestBody(
+			description = "Details of the Item to be created",
+			content = @Content(schema = @Schema(ref = "#/components/schemas/CompanyDtoNew")))
+	public CompanyDto create(@Valid @RequestBody final CompanyDto companyDto) {
+
+		return null;
+	}
+
+
+}

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app5/entities/Company.java

@@ -0,0 +1,29 @@
+package test.org.springdoc.api.app5.entities;
+
+import java.util.UUID;
+
+import javax.validation.constraints.NotNull;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+import org.springframework.hateoas.RepresentationModel;
+import org.springframework.hateoas.server.core.Relation;
+
+/**
+ * @author bnasslahsen
+ */
+@AllArgsConstructor
+@Data
+@Builder
+@EqualsAndHashCode(callSuper = false)
+@Relation(collectionRelation = "companies", itemRelation = "company")
+public class Company extends RepresentationModel<Company> {
+	@JsonProperty(access = JsonProperty.Access.READ_ONLY)
+	private UUID id;
+	@NotNull
+	private String name;
+}

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app5/entities/CompanyDto.java

@@ -0,0 +1,29 @@
+package test.org.springdoc.api.app5.entities;
+
+import java.util.UUID;
+
+import javax.validation.constraints.NotNull;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+import org.springframework.hateoas.RepresentationModel;
+import org.springframework.hateoas.server.core.Relation;
+
+/**
+ * @author bnasslahsen
+ */
+@AllArgsConstructor
+@Data
+@Builder
+@EqualsAndHashCode(callSuper = false)
+@Relation(collectionRelation = "companies", itemRelation = "company")
+public class CompanyDto extends RepresentationModel<CompanyDto> {
+	@JsonProperty(access = JsonProperty.Access.READ_ONLY)
+	private UUID id;
+	@NotNull
+	private String name;
+}

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app5/hateoas/CompanyModelAssembler.java

@@ -0,0 +1,30 @@
+package test.org.springdoc.api.app5.hateoas;
+
+import test.org.springdoc.api.app5.controller.CompanyController;
+import test.org.springdoc.api.app5.entities.Company;
+import test.org.springdoc.api.app5.entities.CompanyDto;
+
+import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport;
+import org.springframework.lang.NonNull;
+import org.springframework.stereotype.Component;
+
+/**
+ * @author bnasslahsen
+ */
+@Component
+public class CompanyModelAssembler extends RepresentationModelAssemblerSupport<Company, CompanyDto> {
+
+	public CompanyModelAssembler() {
+		super(CompanyController.class, CompanyDto.class);
+	}
+
+	@Override
+	@NonNull
+	public CompanyDto toModel(@NonNull final Company company) {
+		final CompanyDto dto = CompanyDto.builder()
+				.id(company.getId())
+				.name(company.getName())
+				.build();
+		return dto;
+	}
+}

springdoc-openapi-hateoas/src/test/resources/results/app5.json

@@ -0,0 +1,115 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/": {
+      "post": {
+        "tags": [
+          "company-controller"
+        ],
+        "operationId": "create",
+        "requestBody": {
+          "description": "Details of the Item to be created",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CompanyDtoNew"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/CompanyDto"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "CompanyDtoNew": {
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "CompanyDto": {
+        "required": [
+          "name"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "readOnly": true
+          },
+          "name": {
+            "type": "string"
+          },
+          "_links": {
+            "$ref": "#/components/schemas/Links"
+          }
+        }
+      },
+      "Links": {
+        "type": "object",
+        "additionalProperties": {
+          "$ref": "#/components/schemas/Link"
+        }
+      },
+      "Link": {
+        "type": "object",
+        "properties": {
+          "href": {
+            "type": "string"
+          },
+          "hreflang": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          },
+          "deprecation": {
+            "type": "string"
+          },
+          "profile": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "templated": {
+            "type": "boolean"
+          }
+        }
+      }
+    }
+  }
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app90.json

@@ -62,7 +62,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "type": "string"
+                "$ref": "#/components/schemas/User"
               },
               "examples": {
                 "An example request with the minimum required fields to create.": {