Path variables parameters are not assigned correctly to endpoints. Fixes #2031

Author: bnasslahsen

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

@@ -35,6 +35,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Locale;
@@ -1103,6 +1104,17 @@ private void fillRouterOperation(RouterFunctionData routerFunctionData, RouterOp
 	private PathItem buildPathItem(RequestMethod requestMethod, Operation operation, String operationPath,
 			Paths paths) {
 		PathItem pathItemObject;
+		if(operation!=null && !CollectionUtils.isEmpty(operation.getParameters())){
+			Iterator<Parameter> paramIt = operation.getParameters().iterator();
+			while (paramIt.hasNext()){
+				Parameter parameter = paramIt.next();
+				if(ParameterIn.PATH.toString().equals(parameter.getIn())){
+					// check it's present in the path
+					if(!operationPath.contains("{" + parameter.getName() + "}"))
+						paramIt.remove();
+				}
+			}
+		}
 		if (paths.containsKey(operationPath))
 			pathItemObject = paths.get(operationPath);
 		else

springdoc-openapi-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java

@@ -163,11 +163,11 @@ void calculatePathFromRouterOperation() {
 		final RouterOperation routerOperation = new RouterOperation();
 		routerOperation.setMethods(new RequestMethod[] { GET });
 		routerOperation.setOperationModel(operation);
-		routerOperation.setPath(PATH);
+		routerOperation.setPath(PATH+"/{"+PARAMETER_WITH_NUMBER_SCHEMA_NAME+"}");
 
 		resource.calculatePath(routerOperation, Locale.getDefault(), this.openAPI);
 
-		final List<Parameter> parameters = resource.getOpenApi(Locale.getDefault()).getPaths().get(PATH).getGet().getParameters();
+		final List<Parameter> parameters = resource.getOpenApi(Locale.getDefault()).getPaths().get(PATH+"/{"+PARAMETER_WITH_NUMBER_SCHEMA_NAME+"}").getGet().getParameters();
 		assertThat(parameters.size(), is(3));
 		assertThat(parameters, containsInAnyOrder(refParameter, numberParameterInPath, parameterWithoutSchema));
 

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app120/MetaAnnotationController.java

@@ -64,7 +64,7 @@ String simpleTest(@PathVariable @AccountId String accountId) {
 	 * @param accountId the account id
 	 * @return the string
 	 */
-	@GetMapping(value = "/testTopLevelParamAnnotationOverrides/{accountId}")
+	@GetMapping(value = "/testTopLevelParamAnnotationOverrides/{id}")
 	String testTopLevelParamAnnotationOverrides(@PathVariable @AccountId @Parameter(name = "id") String accountId) {
 		return accountId;
 	}

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app25/HelloController.java

@@ -54,7 +54,7 @@ void check() {
 	 * @param startDate the start date 
 	 * @param endDate the end date
 	 */
-	@GetMapping(value = "/list")
+	@GetMapping(value = "/list/{trackerId}")
 	void list(
 
 			@Parameter(name = "trackerId", in = ParameterIn.PATH, required = true, schema = @Schema(type = "string", example = "the-tracker-id")) @PathVariable String trackerId,
@@ -69,7 +69,7 @@ void list(
 	 * @param startDate the start date 
 	 * @param endDate the end date
 	 */
-	@GetMapping(value = "/secondlist")
+	@GetMapping(value = "/secondlist/{trackerId}")
 	void secondlist(
 			@Parameter(name = "trackerId", in = ParameterIn.PATH, required = true, schema = @Schema(type = "string", example = "the-tracker-id")) @PathVariable String trackerId,
 			@Parameter(name = "start", in = ParameterIn.QUERY, required = false, schema = @Schema(type = "string", format = "date-time", required = false, example = "1970-01-01T00:00:00.000Z")) @RequestParam(value = "start", required = false) Instant startDate,

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app42/HelloController.java

@@ -34,7 +34,7 @@ public class HelloController {
 	 *
 	 * @param id the id
 	 */
-	@GetMapping(value = "/tweets")
+	@GetMapping(value = "/tweets/{id}")
 	public void tweets(@PathVariable TweetId id) {
 
 	}

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app51/HelloController.java

@@ -87,7 +87,7 @@ public String test3(
 	 * @param params the params 
 	 * @return the string
 	 */
-	@GetMapping("/test")
+	@GetMapping("/test/{path}")
 	public String get(
 			@PathVariable String path,
 			@RequestParam(required = false) Map<String, String> params) {

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app73/HelloController.java

@@ -45,7 +45,7 @@ public class HelloController {
 	 */
 	@DeleteMapping("/{id}")
 	@ResponseStatus(HttpStatus.NO_CONTENT)
-	public void delete(@Parameter(name = "country_code", in = ParameterIn.PATH) String countryCode, @PathVariable("id") String id) {
+	public void delete(@Parameter(name = "country_code", in = ParameterIn.QUERY) String countryCode, @PathVariable("id") String id) {
 
 	}
 
@@ -57,7 +57,7 @@ public void delete(@Parameter(name = "country_code", in = ParameterIn.PATH) Stri
 	 * @return the string
 	 */
 	@GetMapping("/{id}")
-	public String get(@Parameter(name = "country_code", in = ParameterIn.PATH) String countryCode, @PathVariable("id") String id) {
+	public String get(@Parameter(name = "country_code", in = ParameterIn.QUERY) String countryCode, @PathVariable("id") String id) {
 		return null;
 	}
 }

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app75/HelloController.java

@@ -40,7 +40,7 @@ public class HelloController {
 	 *
 	 * @return the string
 	 */
-	@PostMapping("/test1")
+	@PostMapping("/test1/{uuid}")
 	@Operation(summary = "Example api that realize an ECHO operation",
 			description = "The result of the echo is the input value of the api",
 			parameters = { @Parameter(in = ParameterIn.PATH,
@@ -69,7 +69,7 @@ public String postMyRequestBody1() {
 	 *
 	 * @return the string
 	 */
-	@PostMapping("/test2")
+	@PostMapping("/test2/{uuid}")
 	@Operation(summary = "Example api that realize an ECHO operation",
 			description = "The result of the echo is the input value of the api",
 			responses = {
@@ -98,7 +98,7 @@ public String postMyRequestBody2() {
 	 *
 	 * @return the string
 	 */
-	@PostMapping("/test3")
+	@PostMapping("/test3/{uuid}")
 	@Operation(summary = "Example api that realize an ECHO operation",
 			description = "The result of the echo is the input value of the api",
 			parameters = { @Parameter(in = ParameterIn.PATH,

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app89/HelloController.java

@@ -39,7 +39,7 @@ public class HelloController {
 	 * @return the address
 	 */
 	@Operation(summary = "Get Status")
-	@GetMapping(value = "/status", produces = MediaType.TEXT_HTML_VALUE)
+	@GetMapping(value = "/status/{id}", produces = MediaType.TEXT_HTML_VALUE)
 	public ModelAndView getAddress(@PathVariable String id) {
 		return null;
 	}

springdoc-openapi-javadoc/src/test/resources/results/app120.json

@@ -17,7 +17,7 @@
     }
   ],
   "paths": {
-    "/testTopLevelParamAnnotationOverrides/{accountId}": {
+    "/testTopLevelParamAnnotationOverrides/{id}": {
       "get": {
         "tags": [
           "meta-annotation-controller"