Improve httpApiKeyAuth description in OpenAPI

Relates to #872
smithy-lang · Oct 11, 2021 · 1cc72b2 · 1cc72b2
1 parent d8fdf44
commit 1cc72b2
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 7 deletions.
diff --git a/...oftware/amazon/smithy/aws/apigateway/openapi/operation-http-api-key-security.openapi.json b/...oftware/amazon/smithy/aws/apigateway/openapi/operation-http-api-key-security.openapi.json
@@ -25,7 +25,7 @@
     "securitySchemes": {
       "api_key": {
         "type": "apiKey",
-        "description": "X-Api-Key authentication",
+        "description": "API key authentication via the 'x-api-key' header",
         "name": "x-api-key",
         "in": "header"
       }

diff --git a/...main/java/software/amazon/smithy/openapi/fromsmithy/security/HttpApiKeyAuthConverter.java b/...main/java/software/amazon/smithy/openapi/fromsmithy/security/HttpApiKeyAuthConverter.java
@@ -40,21 +40,32 @@ public Class<HttpApiKeyAuthTrait> getAuthSchemeType() {
 
     @Override
     public SecurityScheme createSecurityScheme(Context<? extends Trait> context, HttpApiKeyAuthTrait trait) {
+        StringBuilder description = new StringBuilder()
+                .append("API key authentication via the '")
+                .append(trait.getName())
+                .append("' ");
+
+        if (trait.getIn().equals(HttpApiKeyAuthTrait.Location.QUERY)) {
+            description.append(" query string parameter");
+        } else {
+            description.append(trait.getIn());
+        }
+
         if (trait.getScheme().isPresent()) {
             return SecurityScheme.builder()
                     .type("http")
                     .scheme(trait.getScheme().get())
                     .name(trait.getName())
                     .in(trait.getIn().toString())
-                    .description("ApiKey authentication semantics via 'Authorization' header")
+                    .description(description.toString())
                     .build();
         }
 
         return SecurityScheme.builder()
                 .type("apiKey")
                 .name(trait.getName())
                 .in(trait.getIn().toString())
-                .description("X-Api-Key authentication")
+                .description(description.toString())
                 .build();
     }
 

diff --git a/...rces/software/amazon/smithy/openapi/fromsmithy/security/http-api-key-bearer-security.json b/...rces/software/amazon/smithy/openapi/fromsmithy/security/http-api-key-bearer-security.json
@@ -14,7 +14,7 @@
                 "smithy.api#httpApiKeyAuth": {
                     "name": "Authorization",
                     "in": "header",
-                    "scheme": "ApiKey"
+                    "scheme": "whatever-scheme-we-want"
                 }
             }
         },

diff --git a/...tware/amazon/smithy/openapi/fromsmithy/security/http-api-key-bearer-security.openapi.json b/...tware/amazon/smithy/openapi/fromsmithy/security/http-api-key-bearer-security.openapi.json
@@ -20,10 +20,10 @@
         "securitySchemes": {
             "smithy.api.httpApiKeyAuth": {
                 "type": "http",
-                "description": "ApiKey authentication semantics via 'Authorization' header",
+                "description": "API key authentication via the 'Authorization' header",
                 "name": "Authorization",
                 "in": "header",
-                "scheme": "ApiKey"
+                "scheme": "whatever-scheme-we-want"
             }
         }
     },

diff --git a/...ces/software/amazon/smithy/openapi/fromsmithy/security/http-api-key-security.openapi.json b/...ces/software/amazon/smithy/openapi/fromsmithy/security/http-api-key-security.openapi.json
@@ -20,7 +20,7 @@
         "securitySchemes": {
             "smithy.api.httpApiKeyAuth": {
                 "type": "apiKey",
-                "description": "X-Api-Key authentication",
+                "description": "API key authentication via the 'x-api-key' header",
                 "name": "x-api-key",
                 "in": "header"
             }