-
Notifications
You must be signed in to change notification settings - Fork 68
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 security parameter descriptions #819
Update security parameter descriptions #819
Conversation
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Changes AnalysisCommit SHA: 44291e5 API ChangesSummary
ReportThe full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/13399543787/artifacts/2611991580 API Coverage
|
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Spec Test Coverage Analysis
|
Signed-off-by: Archer <[email protected]>
This PR needs to be reviewed by someone the security team and @natebower before merging. For the security review, I reached out to @cwperks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the PR @Naarcha-AWS. Left a few suggestions.
spec/namespaces/security.yaml
Outdated
@@ -41,7 +41,7 @@ paths: | |||
x-distributions-excluded: | |||
- amazon-managed | |||
- amazon-serverless | |||
description: Returns the authentication information. | |||
description: Returns information about authentication. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: Returns information about authentication. | |
description: Returns information about the currently authenticated user. |
See more details here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a way to prevent the duplication say that one endpoint supports both GET and POST?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We would have to change this to a different x-operation-group
to prevent a spec error.
Co-authored-by: Craig Perkins <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Updates the security parameters descriptions for use in automated API documentation.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.