Skip to content

Commit 34bf57c

Browse files
committed
open-api: security-scheme don't set a name by default only apiKey requires it
1 parent 20db9c0 commit 34bf57c

File tree

6 files changed

+3
-10
lines changed

6 files changed

+3
-10
lines changed

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,6 @@ private static void securitySchemas(OpenAPIExt openapi, List<Map<String, Object>
136136
annotationList(annotation, "extensions", values -> extensions(values, scheme::addExtension));
137137
annotationValue(annotation, "flows", flows -> flows(flows, scheme::flows));
138138

139-
if (scheme.getName() == null || scheme.getName().trim().isEmpty()) {
140-
scheme.setName(name);
141-
}
142139
openapi.addSecuritySchemes(name, scheme);
143140
}
144141
}

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,7 @@ public static Map<String, SecurityScheme> securitySchemes(DetailNode node) {
9696
var item = new SecurityScheme();
9797
item.setDescription((String) hash.get("description"));
9898
var name = (String) hash.get("name");
99-
var paramName = (String) hash.getOrDefault("paramName", name);
100-
item.setName(paramName);
99+
item.setName((String) hash.get("paramName"));
101100
ofNullable((String) hash.get("in"))
102101
.map(String::toUpperCase)
103102
.map(SecurityScheme.In::valueOf)

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ public void shouldParseExtensionFromInfo(OpenAPIResult result) {
4343
+ " securitySchemes:\n"
4444
+ " myOauth2Security:\n"
4545
+ " type: oauth2\n"
46-
+ " name: myOauth2Security\n"
4746
+ " in: header\n"
4847
+ " flows:\n"
4948
+ " implicit:\n"

modules/jooby-openapi/src/test/java/issues/i3652/Issue3652.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ public void shouldGenerateSecuritySchemeFromController(OpenAPIResult result) {
4646
+ " securitySchemes:\n"
4747
+ " myBearerToken:\n"
4848
+ " type: http\n"
49-
+ " name: myBearerToken\n"
5049
+ " in: header\n"
5150
+ " scheme: bearer\n"
5251
+ " bearerFormat: JWT\n",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* Security Scheme.
1313
*
1414
* @securityScheme.name myOauth2Security
15-
* @securityScheme.type oauth2
15+
* @securityScheme.type apiKey
1616
* @securityScheme.in header
1717
* @securityScheme.paramName X-Auth
1818
* @securityScheme.flows.implicit.authorizationUrl http://url.com/auth

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public void shouldGenerateDocFromMountedApp(OpenAPIResult result) {
5252
+ "components:\n"
5353
+ " securitySchemes:\n"
5454
+ " myOauth2Security:\n"
55-
+ " type: oauth2\n"
55+
+ " type: apiKey\n"
5656
+ " name: X-Auth\n"
5757
+ " in: header\n"
5858
+ " flows:\n"
@@ -63,7 +63,6 @@ public void shouldGenerateDocFromMountedApp(OpenAPIResult result) {
6363
+ " read:pets: read your pets\n"
6464
+ " myOauth:\n"
6565
+ " type: oauth2\n"
66-
+ " name: myOauth\n"
6766
+ " in: header\n"
6867
+ " flows:\n"
6968
+ " implicit:\n"

0 commit comments

Comments
 (0)