When @get, using @parameter over the method results in duplicate of the same parameter. Fixes #1901

bnasslahsen · bnasslahsen · commit 9150ee4f320c · 2022-10-22T15:29:09.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java
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
@@ -191,7 +191,7 @@ public static Parameter mergeParameter(List<Parameter> existingParamDoc, Paramet
 	 * @param paramCalcul the param calcul
 	 * @param paramDoc the param doc
 	 */
-	private static void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {
+	public static void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {
 		if (StringUtils.isBlank(paramDoc.getDescription()))
 			paramDoc.setDescription(paramCalcul.getDescription());
 
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/ParameterId.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/ParameterId.java
@@ -24,7 +24,6 @@
 
 import java.util.Objects;
 
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import org.apache.commons.lang3.StringUtils;
 
@@ -67,8 +66,19 @@ public ParameterId(Parameter parameter) {
 	 */
 	public ParameterId(io.swagger.v3.oas.annotations.Parameter parameter) {
 		this.pName = parameter.name();
-		this.paramType = parameter.in().toString();
-		this.$ref = parameter.ref();
+		this.paramType = StringUtils.isNotBlank(parameter.in().toString()) ? parameter.in().toString():null;
+		this.$ref = StringUtils.isNotBlank(parameter.ref()) ? parameter.ref():null;
+	}
+
+	/**
+	 * Instantiates a new Parameter id.
+	 *
+	 * @param pName the p name
+	 * @param paramType the param type
+	 */
+	public ParameterId(String pName, String paramType) {
+		this.pName = pName;
+		this.paramType =paramType;
 	}
 
 	/**
@@ -136,7 +146,6 @@ public boolean equals(Object o) {
 			return Objects.equals(pName, that.pName);
 
 		return Objects.equals(pName, that.pName) && Objects.equals(paramType, that.paramType);
-
 	}
 
 	@Override
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/ParameterInfo.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/ParameterInfo.java
@@ -22,6 +22,7 @@
 
 package org.springdoc.core;
 
+import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
@@ -76,6 +77,11 @@ public class ParameterInfo {
 	 */
 	private boolean requestPart;
 
+	/**
+	 * The Parameter id.
+	 */
+	private ParameterId parameterId;
+
 	/**
 	 * The constant LOGGER.
 	 */
@@ -86,8 +92,9 @@ public class ParameterInfo {
 	 * @param pName the parameter name
 	 * @param methodParameter the method parameter
 	 * @param genericParameterService the parameter builder
+	 * @param parameterAnnotation the parameter annotation
 	 */
-	public ParameterInfo(String pName, MethodParameter methodParameter, GenericParameterService genericParameterService) {
+	public ParameterInfo(String pName, MethodParameter methodParameter, GenericParameterService genericParameterService, Parameter parameterAnnotation) {
 		RequestHeader requestHeader = methodParameter.getParameterAnnotation(RequestHeader.class);
 		RequestParam requestParam = methodParameter.getParameterAnnotation(RequestParam.class);
 		PathVariable pathVar = methodParameter.getParameterAnnotation(PathVariable.class);
@@ -123,6 +130,15 @@ else if (cookieValue != null)
 		}
 
 		this.required = this.required && !methodParameter.isOptional();
+		if (parameterAnnotation != null){
+			this.parameterId = new ParameterId(parameterAnnotation);
+			if(StringUtils.isBlank(parameterId.getpName()))
+				this.parameterId.setpName(this.pName);
+			if(StringUtils.isBlank(parameterId.getParamType()))
+				this.parameterId.setParamType(this.paramType);
+		}
+		else
+			this.parameterId = new ParameterId(this.pName, paramType);
 	}
 
 	/**
@@ -294,4 +310,22 @@ public boolean isRequestPart() {
 	public void setRequestPart(boolean requestPart) {
 		this.requestPart = requestPart;
 	}
+
+	/**
+	 * Gets parameter id.
+	 *
+	 * @return the parameter id
+	 */
+	public ParameterId getParameterId() {
+		return parameterId;
+	}
+
+	/**
+	 * Sets parameter id.
+	 *
+	 * @param parameterId the parameter id
+	 */
+	public void setParameterId(ParameterId parameterId) {
+		this.parameterId = parameterId;
+	}
 }
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
@@ -153,7 +153,10 @@ public void buildCommonParameters(OpenAPI openAPI, RequestMethod requestMethod,
 		Class<?> domainType = dataRestRepository.getDomainType();
 		for (MethodParameter methodParameter : parameters) {
 			final String pName = methodParameter.getParameterName();
-			ParameterInfo parameterInfo = new ParameterInfo(pName, methodParameter, parameterBuilder);
+			io.swagger.v3.oas.annotations.Parameter parameterDoc = AnnotatedElementUtils.findMergedAnnotation(
+					AnnotatedElementUtils.forAnnotations(methodParameter.getParameterAnnotations()),
+					io.swagger.v3.oas.annotations.Parameter.class);
+			ParameterInfo parameterInfo = new ParameterInfo(pName, methodParameter, parameterBuilder,parameterDoc);
 			if (isParamToIgnore(methodParameter)) {
 				if (PersistentEntityResource.class.equals(methodParameter.getParameterType())) {
 					Schema<?> schema = SpringDocAnnotationsUtils.resolveSchemaFromType(domainType, openAPI.getComponents(), null, methodParameter.getParameterAnnotations());
@@ -163,9 +166,6 @@ else if (methodParameter.getParameterAnnotation(BackendId.class) != null) {
 					parameterInfo.setParameterModel(new Parameter().name("id").in(ParameterIn.PATH.toString()).schema(new StringSchema()));
 				}
 				Parameter parameter = null;
-				io.swagger.v3.oas.annotations.Parameter parameterDoc = AnnotatedElementUtils.findMergedAnnotation(
-						AnnotatedElementUtils.forAnnotations(methodParameter.getParameterAnnotations()),
-						io.swagger.v3.oas.annotations.Parameter.class);
 				if (parameterDoc != null) {
 					if (parameterDoc.hidden() || parameterDoc.schema().hidden())
 						continue;
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app87/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app87/HelloController.java
@@ -36,6 +36,7 @@
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 
@@ -69,4 +70,28 @@ void list(@RequestHeader(value = "access_token", required = false)
 	}
 	public static class Item {
 	}
+
+	@GetMapping("/duplicate_param")
+	@Operation(summary = "Duplicate param")
+	@Parameter(name = "sample", required = true, in = ParameterIn.HEADER, description = "sample Header")
+	@Parameter(name = "sample", required = true, in = ParameterIn.QUERY, description = "sample query")
+	public String duplicateParam(@RequestParam String sample, @RequestHeader("sample") String sampleHeader) {
+		return "duplicateParam";
+	}
+
+	@GetMapping("/duplicate_param2")
+	@Operation(summary = "Duplicate param")
+	@Parameter(name = "sample", required = true, description = "sample")
+	public String duplicateParam2(@RequestParam String sample) {
+		return "duplicateParam";
+	}
+
+
+	@GetMapping("/duplicate_param3")
+	@Operation(summary = "Duplicate param")
+	@Parameter(name = "sample", required = true, description = "sample")
+	public String duplicateParam3(@RequestHeader String sample) {
+		return "duplicateParam";
+	}
+
 }
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app87.json b/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app87.json
@@ -91,6 +91,111 @@
           }
         }
       }
+    },
+    "/duplicate_param": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "summary": "Duplicate param",
+        "operationId": "duplicateParam",
+        "parameters": [
+          {
+            "name": "sample",
+            "in": "query",
+            "description": "sample query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "sample",
+            "in": "header",
+            "description": "sample Header",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/duplicate_param3": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "summary": "Duplicate param",
+        "operationId": "duplicateParam3",
+        "parameters": [
+          {
+            "name": "sample",
+            "in": "header",
+            "description": "sample",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/duplicate_param2": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "summary": "Duplicate param",
+        "operationId": "duplicateParam2",
+        "parameters": [
+          {
+            "name": "sample",
+            "in": "query",
+            "description": "sample",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
