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.

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

Update OpenAPI security guidelines.md #57

Merged
merged 3 commits into from
Feb 8, 2024

Conversation

jlurien
Copy link
Contributor

@jlurien jlurien commented Sep 6, 2023

What type of PR is this?

  • documentation

What this PR does / why we need it:

Add detailed guidelines on how to model scopes, security and securitySchemes in OpenAPI spec.

  • Scope format
  • openIdConnect as preferred securityScheme type

Which issue(s) this PR fixes:

Based on discussion and comments - resolves #53
It also fixes #46

Changelog input

 Changes section 11.6 Security definition

Additional documentation

n/a

@eric-murray
Copy link
Collaborator

Please review or comment by next Commonalities meeting (currently 21st, but may be moved due to clash with next TSC meeting).

jordonezlucena
jordonezlucena previously approved these changes Sep 12, 2023
Copy link
Collaborator

@jordonezlucena jordonezlucena left a comment

Choose a reason for hiding this comment

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

LGTM

documentation/API-design-guidelines.md Outdated Show resolved Hide resolved
documentation/API-design-guidelines.md Outdated Show resolved Hide resolved
documentation/API-design-guidelines.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

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

/LGTM

@jlurien
Copy link
Contributor Author

jlurien commented Jan 25, 2024

PR has been updated with a reference to the document in I&CM WG regarding security and securitySchemes guidelines. Only the section about scope naming is kept here. cc @rartych

Copy link
Collaborator

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
9 participants