Use api-key instead of api_key as example header name
#3226
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Several HTTP servers drop http headers with underscores. Fixes OAI#3225
perrinjerome
commented
Apr 1, 2023
| @@ -563,7 +563,7 @@ my.org.User | |||
| "securitySchemes": { | |||
| "api_key": { | |||
| "type": "apiKey", | |||
| "name": "api_key", | |||
| "name": "api-key", | |||
There was a problem hiding this comment.
Here I have only changed the name and kept the id to be "api_key", therefore later in "Security Requirement Object" section, it stays using "api_key"
OpenAPI-Specification/versions/3.1.1.md
Lines 3370 to 3381 in 9bf45ce
I first replaced all api_key by api-key but I thought it would be better to keep consistent api_key to have consistent naming with petstore_auth
charjr
pushed a commit
to charjr/OpenAPI-Specification
that referenced
this pull request
Apr 27, 2023
Several HTTP servers drop http headers with underscores. Fixes OAI#3225
charjr
pushed a commit
to charjr/OpenAPI-Specification
that referenced
this pull request
Apr 27, 2023
Several HTTP servers drop http headers with underscores. Fixes OAI#3225
handrews
added
clarification
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Several HTTP servers drop http headers with underscores.
Fixes #3225