Map type with @RequestParam(required = false) in method isn't ignored. Fixes #553

Author: bnasslahsen

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

@@ -255,7 +255,7 @@ protected Parameter customiseParameter(Parameter parameter, ParameterInfo parame
 	protected boolean isParamToIgnore(MethodParameter parameter) {
 		if (parameterBuilder.isAnnotationToIgnore(parameter))
 			return true;
-		if (parameter.getParameterAnnotation(PathVariable.class) != null || parameter.getParameterAnnotation(RequestParam.class) != null)
+		if ((parameter.getParameterAnnotation(PathVariable.class) != null && parameter.getParameterAnnotation(PathVariable.class) .required()) || (parameter.getParameterAnnotation(RequestParam.class) != null && parameter.getParameterAnnotation(RequestParam.class).required()))
 			return false;
 		return isRequestTypeToIgnore(parameter.getParameterType());
 	}

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

@@ -18,12 +18,15 @@
 
 package test.org.springdoc.api.app51;
 
+import java.util.Map;
+
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.media.Schema;
 
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -53,4 +56,11 @@ public String test3(
 		return "test";
 	}
 
+	@GetMapping("/test")
+	public String get(
+			@PathVariable String path,
+			@RequestParam(required = false) Map<String, String> params) {
+		return null;
+	}
+
 }

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

@@ -11,6 +11,36 @@
     }
   ],
   "paths": {
+    "/test": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "get",
+        "parameters": [
+          {
+            "name": "path",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/test1": {
       "get": {
         "tags": [
@@ -42,12 +72,12 @@
         }
       }
     },
-    "/test2": {
+    "/test3": {
       "get": {
         "tags": [
           "hello-controller"
         ],
-        "operationId": "test2",
+        "operationId": "test3",
         "parameters": [
           {
             "name": "test_header",
@@ -61,9 +91,11 @@
           {
             "name": "param1",
             "in": "query",
+            "description": "desc1",
             "required": true,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "something"
             }
           }
         ],
@@ -81,12 +113,12 @@
         }
       }
     },
-    "/test3": {
+    "/test2": {
       "get": {
         "tags": [
           "hello-controller"
         ],
-        "operationId": "test3",
+        "operationId": "test2",
         "parameters": [
           {
             "name": "test_header",
@@ -100,11 +132,9 @@
           {
             "name": "param1",
             "in": "query",
-            "description": "desc1",
             "required": true,
             "schema": {
-              "type": "string",
-              "example": "something"
+              "type": "string"
             }
           }
         ],