open-api: add SecurityScheme.paramName support

- it was missed while parsing

Author: jknack

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

@@ -37,13 +37,13 @@ public void setSource(String classname) {
     this.source = classname;
   }
 
-  public void addSecuritySchemes(SecurityScheme scheme) {
+  public void addSecuritySchemes(String name, SecurityScheme scheme) {
     var components = getComponents();
     if (components == null) {
       components = new Components();
       setComponents(components);
     }
-    components.addSecuritySchemes(scheme.getName(), scheme);
+    components.addSecuritySchemes(name, scheme);
   }
 
   @Override

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

@@ -123,7 +123,8 @@ private static void securitySchemas(OpenAPIExt openapi, List<Map<String, Object>
           annotation,
           "type",
           v -> scheme.setType(io.swagger.v3.oas.models.security.SecurityScheme.Type.valueOf(v)));
-      stringValue(annotation, "name", scheme::setName);
+      var name = stringValue(annotation, "name");
+      stringValue(annotation, "paramName", scheme::setName);
       stringValue(annotation, "description", scheme::setDescription);
       enumValue(
           annotation,
@@ -135,7 +136,10 @@ private static void securitySchemas(OpenAPIExt openapi, List<Map<String, Object>
       annotationList(annotation, "extensions", values -> extensions(values, scheme::addExtension));
       annotationValue(annotation, "flows", flows -> flows(flows, scheme::flows));
 
-      openapi.addSecuritySchemes(scheme);
+      if (scheme.getName() == null || scheme.getName().trim().isEmpty()) {
+        scheme.setName(name);
+      }
+      openapi.addSecuritySchemes(name, scheme);
     }
   }
 

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/javadoc/ClassDoc.java

@@ -30,7 +30,7 @@ public class ClassDoc extends JavaDocNode {
   private final List<Server> servers;
   private final List<Contact> contact;
   private final List<License> license;
-  private final List<SecurityScheme> securitySchemes;
+  private final Map<String, SecurityScheme> securitySchemes;
 
   public ClassDoc(JavaDocParser ctx, DetailAST node, DetailAST javaDoc) {
     super(ctx, node, javaDoc);
@@ -45,7 +45,7 @@ public ClassDoc(JavaDocParser ctx, DetailAST node, DetailAST javaDoc) {
     this.securitySchemes = JavaDocTag.securitySchemes(this.javadoc);
   }
 
-  public List<SecurityScheme> getSecuritySchemes() {
+  public Map<String, SecurityScheme> getSecuritySchemes() {
     return securitySchemes;
   }
 

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/javadoc/JavaDocTag.java

@@ -88,13 +88,16 @@ public static List<SecurityRequirement> securityRequirement(DetailNode node) {
         .toList();
   }
 
-  public static List<SecurityScheme> securitySchemes(DetailNode node) {
-    return parse(node, SECURITY_SCHEME, "securityScheme").stream()
-        .map(
+  public static Map<String, SecurityScheme> securitySchemes(DetailNode node) {
+    var result = new LinkedHashMap<String, SecurityScheme>();
+    parse(node, SECURITY_SCHEME, "securityScheme")
+        .forEach(
             hash -> {
               var item = new SecurityScheme();
               item.setDescription((String) hash.get("description"));
-              item.setName((String) hash.get("name"));
+              var name = (String) hash.get("name");
+              var paramName = (String) hash.getOrDefault("paramName", name);
+              item.setName(paramName);
               ofNullable((String) hash.get("in"))
                   .map(String::toUpperCase)
                   .map(SecurityScheme.In::valueOf)
@@ -115,9 +118,9 @@ public static List<SecurityScheme> securitySchemes(DetailNode node) {
                 toOauthFlow("clientCredentials", hashFlows, flows::setClientCredentials);
                 item.setFlows(flows);
               }
-              return item;
-            })
-        .toList();
+              result.put(name, item);
+            });
+    return result;
   }
 
   private static void toOauthFlow(String path, Map<?, ?> flows, Consumer<OAuthFlow> consumer) {

modules/jooby-openapi/src/test/java/issues/i3729/api/SecuritySchemaDocApp.java

@@ -14,6 +14,7 @@
  * @securityScheme.name myOauth2Security
  * @securityScheme.type oauth2
  * @securityScheme.in header
+ * @securityScheme.paramName X-Auth
  * @securityScheme.flows.implicit.authorizationUrl http://url.com/auth
  * @securityScheme.flows.implicit.scopes.name [write:pets, read:pets]
  * @securityScheme.flows.implicit.scopes.description [modify pets in your account, read your pets]

modules/jooby-openapi/src/test/java/issues/i3729/api/SecuritySchemeDocTest.java

@@ -53,7 +53,7 @@ public void shouldGenerateDocFromMountedApp(OpenAPIResult result) {
             + "  securitySchemes:\n"
             + "    myOauth2Security:\n"
             + "      type: oauth2\n"
-            + "      name: myOauth2Security\n"
+            + "      name: X-Auth\n"
             + "      in: header\n"
             + "      flows:\n"
             + "        implicit:\n"

modules/jooby-openapi/src/test/java/javadoc/JavaDocObjectParserTest.java

@@ -108,20 +108,6 @@ void testMismatchedNestedValueCount() {
         result);
   }
 
-  @Test
-  @DisplayName("Should throw exception on path conflict")
-  void testPathConflict() {
-    List<String> input = List.of("user", "test.user", "user.role", "admin");
-
-    Exception exception =
-        assertThrows(
-            IllegalArgumentException.class,
-            () -> {
-              JavaDocObjectParser.parse(input);
-            });
-    assertTrue(exception.getMessage().contains("contains a value and cannot be treated as a map"));
-  }
-
   @Test
   @DisplayName("Should handle a single bracketed value as a list")
   void testBracketedValueAsList() {