openapi: remove path parameter when generating operations from optional params

Author: jknack

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/AnnotationParser.java

@@ -86,6 +86,7 @@ enum ParamType {
 
       @Override public void setIn(Parameter parameter) {
         parameter.setIn("path");
+        parameter.setRequired(true);
       }
     },
     QUERY {

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/OperationExt.java

@@ -7,6 +7,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import io.jooby.MediaType;
+import io.jooby.Router;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import io.swagger.v3.oas.models.tags.Tag;
@@ -221,7 +222,19 @@ public OperationExt copy(String pattern) {
     OperationExt copy = new OperationExt(node, method, pattern, getParameters(), defaultResponse);
     copy.setTags(getTags());
     copy.setResponses(getResponses());
-    copy.setParameters(getParameters());
+
+    /** Redo path keys: */
+    List<String> keys = Router.pathKeys(pattern);
+    List<Parameter> newParameters = new ArrayList<>();
+    List<Parameter> parameters = getParameters();
+    for (String key : keys) {
+      parameters.stream()
+          .filter(p -> p.getName().equals(key))
+          .findFirst()
+          .ifPresent(newParameters::add);
+    }
+    copy.setParameters(newParameters);
+
     copy.setRequestBody(getRequestBody());
     copy.setHidden(getHidden());
     copy.setMethod(getMethod());

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/ParameterExt.java

@@ -48,6 +48,10 @@ public void setDefaultValue(Object defaultValue) {
     this.defaultValue = defaultValue;
   }
 
+  @Override public void setRequired(Boolean required) {
+    super.setRequired(required);
+  }
+
   @Override public String toString() {
     return javaType + " " + getName();
   }

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/RequestParser.java

@@ -194,10 +194,12 @@ public static List<ParameterExt> parameters(MethodNode node) {
       Signature signature = Signature.create(methodInsnNode);
       ParameterExt argument = new ParameterExt();
       String scope = signature.getMethod();
+      Boolean required = null;
       switch (scope) {
+        case "path":
+          required = true;
         case "header":
         case "cookie":
-        case "path":
         case "query": {
           argument.setIn(scope);
           if (signature.matches(String.class)) {
@@ -211,7 +213,9 @@ public static List<ParameterExt> parameters(MethodNode node) {
           }
         }
       }
-
+      if (required != null) {
+        argument.setRequired(required);
+      }
       if (argument.getJavaType() != null) {
         args.add(argument);
       } else {

modules/jooby-openapi/src/test/java/io/jooby/openapi/OpenAPIGeneratorTest.java

@@ -309,71 +309,71 @@ public void routePathArguments(RouteIterator iterator) {
                 assertEquals("java.util.List<java.lang.String>", it.getJavaType());
                 assertEquals("listStr", it.getName());
                 assertNull(it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals("java.util.List<java.lang.Double>", it.getJavaType());
                 assertEquals("listType", it.getName());
                 assertNull(it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals(String.class.getName(), it.getJavaType());
                 assertEquals("defstr", it.getName());
                 assertEquals("200", it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals(int.class.getName(), it.getJavaType());
                 assertEquals("defint", it.getName());
                 assertEquals(87, it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals(int.class.getName(), it.getJavaType());
                 assertEquals("defint0", it.getName());
                 assertEquals(0, it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals(boolean.class.getName(), it.getJavaType());
                 assertEquals("defbool", it.getName());
                 assertEquals(true, it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals("java.util.Optional<java.lang.String>", it.getJavaType());
                 assertEquals("optstr", it.getName());
                 assertEquals(null, it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals("java.util.Optional<java.lang.Integer>", it.getJavaType());
                 assertEquals("optint", it.getName());
                 assertEquals(null, it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })
               .next(it -> {
                 assertEquals("java.util.Optional<java.lang.String>", it.getJavaType());
                 assertEquals("optstr2", it.getName());
                 assertEquals("optional", it.getDefaultValue());
-                assertFalse(it.getRequired());
+                assertTrue(it.getRequired());
                 assertTrue(it.isSingle());
                 assertEquals("path", it.getIn());
               })

modules/jooby-openapi/src/test/java/issues/Issue1573.java

@@ -18,12 +18,6 @@ public void shouldGenerateExpandPaths(OpenAPIResult result) {
         + "  /profile:\n"
         + "    get:\n"
         + "      operationId: getProfile\n"
-        + "      parameters:\n"
-        + "      - name: id\n"
-        + "        in: path\n"
-        + "        required: false\n"
-        + "        schema:\n"
-        + "          type: string\n"
         + "      responses:\n"
         + "        \"200\":\n"
         + "          description: Success\n"
@@ -37,7 +31,7 @@ public void shouldGenerateExpandPaths(OpenAPIResult result) {
         + "      parameters:\n"
         + "      - name: id\n"
         + "        in: path\n"
-        + "        required: false\n"
+        + "        required: true\n"
         + "        schema:\n"
         + "          type: string\n"
         + "      responses:\n"
@@ -50,12 +44,6 @@ public void shouldGenerateExpandPaths(OpenAPIResult result) {
         + "  /c/profile:\n"
         + "    get:\n"
         + "      operationId: profile\n"
-        + "      parameters:\n"
-        + "      - name: id\n"
-        + "        in: path\n"
-        + "        required: true\n"
-        + "        schema:\n"
-        + "          type: string\n"
         + "      responses:\n"
         + "        \"200\":\n"
         + "          description: Success\n"