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

Author: bnasslahsen

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

@@ -37,6 +37,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;
@@ -1099,6 +1100,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-starter-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java

@@ -166,11 +166,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-starter-webflux-api/pom.xml

@@ -28,6 +28,12 @@
 			<artifactId>spring-boot-starter-reactor-netty</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-resolver-dns-native-macos</artifactId>
+			<classifier>osx-aarch_64</classifier>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 	<build>
 		<plugins>

springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app70/CoffeeService.java

@@ -26,9 +26,9 @@ Mono<Coffee> getCoffeeById(@Parameter(in = ParameterIn.PATH) String id) {
 		return repo.findById(id);
 	}
 
-	Flux<CoffeeOrder> getOrdersForCoffeeById(@Parameter(in = ParameterIn.PATH) String coffeeId) {
+	Flux<CoffeeOrder> getOrdersForCoffeeById(@Parameter(in = ParameterIn.PATH) String id) {
 		return Flux.interval(Duration.ofSeconds(1))
 				.onBackpressureDrop()
-				.map(i -> new CoffeeOrder(coffeeId, Instant.now()));
+				.map(i -> new CoffeeOrder(id, Instant.now()));
 	}
 }

springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/app83/CoffeeService.java

@@ -26,9 +26,9 @@ Mono<Coffee> getCoffeeById(@Parameter(in = ParameterIn.PATH) String id) {
 		return repo.findById(id);
 	}
 
-	Flux<CoffeeOrder> getOrdersForCoffeeById(@Parameter(in = ParameterIn.PATH) String coffeeId) {
+	Flux<CoffeeOrder> getOrdersForCoffeeById(@Parameter(in = ParameterIn.PATH) String id) {
 		return Flux.interval(Duration.ofSeconds(1))
 				.onBackpressureDrop()
-				.map(i -> new CoffeeOrder(coffeeId, Instant.now()));
+				.map(i -> new CoffeeOrder(id, Instant.now()));
 	}
 }

springdoc-openapi-starter-webflux-api/src/test/resources/results/app70.json

@@ -72,7 +72,7 @@
         "operationId": "getOrdersForCoffeeById",
         "parameters": [
           {
-            "name": "coffeeId",
+            "name": "id",
             "in": "path",
             "required": true,
             "schema": {

springdoc-openapi-starter-webflux-api/src/test/resources/results/app83.json

@@ -72,7 +72,7 @@
         "operationId": "getOrdersForCoffeeById",
         "parameters": [
           {
-            "name": "coffeeId",
+            "name": "id",
             "in": "path",
             "required": true,
             "schema": {

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app120/MetaAnnotationController.java

@@ -2,21 +2,19 @@
  *
  *  *
  *  *  *
+ *  *  *  * Copyright 2019-2022 the original author or authors.
  *  *  *  *
- *  *  *  *  * Copyright 2019-2022 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.
+ *  *  *  * 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.
  *  *  *
  *  *
  *
@@ -59,7 +57,7 @@ String simpleTest(@PathVariable @AccountId String accountId) {
 	 * When there is a top level {@code @Parameter} annotation it has precedence over the meta-annotation
 	 * So the id parameter should have all the defaults, with a name of "id"
 	 */
-	@GetMapping(value = "/testTopLevelParamAnnotationOverrides/{accountId}")
+	@GetMapping(value = "/testTopLevelParamAnnotationOverrides/{id}")
 	String testTopLevelParamAnnotationOverrides(@PathVariable @AccountId @Parameter(name = "id") String accountId) {
 		return accountId;
 	}

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app25/HelloController.java

@@ -2,21 +2,19 @@
  *
  *  *
  *  *  *
+ *  *  *  * Copyright 2019-2022 the original author or authors.
  *  *  *  *
- *  *  *  *  * Copyright 2019-2022 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.
+ *  *  *  * 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.
  *  *  *
  *  *
  *
@@ -55,7 +53,7 @@ void list(
 			@Parameter(name = "end", in = ParameterIn.QUERY, required = false, schema = @Schema(type = "string", format = "date-time", required = false, example = "1970-01-01T00:10:00.000Z")) @RequestParam(value = "end", required = false) Instant endDate) {
 	}
 
-	@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-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app42/HelloController.java

@@ -2,21 +2,19 @@
  *
  *  *
  *  *  *
+ *  *  *  * Copyright 2019-2022 the original author or authors.
  *  *  *  *
- *  *  *  *  * Copyright 2019-2022 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.
+ *  *  *  * 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.
  *  *  *
  *  *
  *
@@ -32,7 +30,7 @@
 @RestController("/api")
 public class HelloController {
 
-	@GetMapping(value = "/tweets")
+	@GetMapping(value = "/tweets/{id}")
 	public void tweets(@PathVariable TweetId id) {
 
 	}