Skip to content

Update security.md #110

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.

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

Merged
merged 3 commits into from
Oct 8, 2024
Merged

Update security.md #110

merged 3 commits into from
Oct 8, 2024

Conversation

darrelmiller
Copy link
Member

Fix security examples as the security property is an array.

Fix security examples as the security property is an array.
@kevinswiber
Copy link

@darrelmiller I think this also needs to be fixed on lines 58, 142, and 188.

Copy link

@kevinswiber kevinswiber left a comment

Choose a reason for hiding this comment

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

@darrelmiller Just one little hiccup. Otherwise, LGTM!

@karenetheridge
Copy link
Member

"defaultApiKey" is not one of the valid entries for a securityScheme. The schema currently only allows for one of: apiKey, http, mutualTLS, oauth2, openIdConnect.

@kevinswiber
Copy link

"defaultApiKey" is not one of the valid entries for a securityScheme. The schema currently only allows for one of: apiKey, http, mutualTLS, oauth2, openIdConnect.

@karenetheridge I believe this is the name in the Security Requirement Object, which must correspond to a name in #/components/securitySchemes. The example shows a Security Scheme Object in Components that's called defaultApiKey, so I think this might be correct.

@karenetheridge
Copy link
Member

Aha, my confusion came from "The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object." -- which I interpreted as the type, not the property name under components.

@handrews
Copy link
Member

handrews commented Oct 4, 2024

@karenetheridge

Aha, my confusion came from "The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object." -- which I interpreted as the type, not the property name under components.

Ah, good catch. The wording could perhaps be something like "The name used for each property MUST correspond to the name of a property under the securitySchemes field of the Components Object."

@ralfhandl ralfhandl requested review from kevinswiber and a team October 8, 2024 10:02
Copy link

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good. 👍

@ralfhandl ralfhandl merged commit 1d8e4b9 into main Oct 8, 2024
@ralfhandl ralfhandl deleted the darrelmiller-patch-1 branch October 8, 2024 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants