[PMM-275] OAS Hub: Security#39
Merged
Merged
Conversation
philsturgeon
force-pushed
the
oas/security
branch
from
62b44bc to
6eb4cdd
Compare
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
|
|
||
| ## How to describe security schemes | ||
|
|
||
| [securitySchemes](https://spec.openapis.org/oas/v3.1.0#security-scheme-object/security-schemes) are the actual details of the options provided in the [security](https://spec.openapis.org/oas/v3.1.0#security-requirement-object) sections of your document. The security schemes are components that are defined with the [components](https://spec.openapis.org/oas/v3.1.0#components-object) section of your document. Below is an example of the 5 types of security schemes described above and how they are defined: |
Contributor
There was a problem hiding this comment.
Solid start!
I'd say the thing to decide on is capitalization for security schemes and then be consistent :)
Contributor
Author
There was a problem hiding this comment.
@chailandau I remember the style guide suggesting new concepts should be capitalized then it could be referred to as normal lowercase from there. I think it would look a little odd if it was always upper?
Contributor
There was a problem hiding this comment.
@iamsimonyu thoughts here? I can't seem to find that bit of the style guide and will defer to you
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
chailandau
reviewed
May 23, 2025
seems to be some duplication on index.mdx so removed for now. need to properly seperate and cross link security schemes vs requirements.
Co-authored-by: Chai Landau <112015853+chailandau@users.noreply.github.com>
Co-authored-by: Chai Landau <112015853+chailandau@users.noreply.github.com>
philsturgeon
force-pushed
the
oas/security
branch
from
f34d0b6 to
f0151f7
Compare
Contributor
Author
|
@chailandau alright! This is ready for review now (conten complete) and I'm here for any sort of feedback you have. |
simplesagar
approved these changes
Jun 4, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Takes care of PMM-278, PMM-279, РMM-280, PMM-281, and PMM-282, so lets see how good the Linear integration is.
A refresh of the security / security requirements content. Needs a little more work but its trying to be a bit more human and explain things beyond just the objects.
Also:
openapi/security-schemes/index.mdxwhich seems to be identical toopenapi/security/security-schemes.md(let me know if this was the wrong way around)