Use api-key instead of api_key as example header name (OAI#3226)

Several HTTP servers drop http headers with underscores. Fixes OAI#3225
charjr · Apr 27, 2023 · a304b30 · a304b30
1 parent aba43bc
commit a304b30
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/versions/3.1.1.md b/versions/3.1.1.md
@@ -563,7 +563,7 @@ my.org.User
   "securitySchemes": {
     "api_key": {
       "type": "apiKey",
-      "name": "api_key",
+      "name": "api-key",
       "in": "header"
     },
     "petstore_auth": {
@@ -640,7 +640,7 @@ components:
   securitySchemes:
     api_key:
       type: apiKey
-      name: api_key
+      name: api-key
       in: header
     petstore_auth:
       type: oauth2
@@ -3226,14 +3226,14 @@ scheme: basic
 ```json
 {
   "type": "apiKey",
-  "name": "api_key",
+  "name": "api-key",
   "in": "header"
 }
 ```
 
 ```yaml
 type: apiKey
-name: api_key
+name: api-key
 in: header
 ```