Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Apr 13, 2023
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions versions/3.1.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ my.org.User
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"name": "api-key",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

###### Non-OAuth2 Security Requirement
```json
{
"api_key": []
}
```
```yaml
api_key: []
```

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

"in": "header"
},
"petstore_auth": {
Expand Down Expand Up @@ -640,7 +640,7 @@ components:
securitySchemes:
api_key:
type: apiKey
name: api_key
name: api-key
in: header
petstore_auth:
type: oauth2
Expand Down Expand Up @@ -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
```

Expand Down