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

Adds API spec for security plugin #271

Merged
merged 17 commits into from
May 10, 2024
Merged

Adds API spec for security plugin #271

merged 17 commits into from
May 10, 2024

Conversation

DarshitChanpura
Copy link
Member

Description

Corrects invalid entries and adds missing entries for the security plugin.

Issues Resolved

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.

@DarshitChanpura
Adds missing entries in the spec as well superseded yml files
6c77e05 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@dblock dblock mentioned this pull request Apr 25, 2024
Closed
@DarshitChanpura
Re-organized HTTP methods in GET, POST, PUT, PATCH, DELETE order
3ef5417 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Re-arrange alphabetically
d19d816 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Added all missing endpoints
d736dc7 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
dblock
dblock reviewed Apr 29, 2024
View reviewed changes
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Go through descriptions and ensure common format (missing periods at the end of sentences).

Is this ready, mark it ready for review?

spec/schemas/security._common.yaml Outdated Show resolved Hide resolved
spec/namespaces/security.yaml Outdated Show resolved Hide resolved
@DarshitChanpura
Copy link
Member Author

@dblock ty for your review. This isn't ready yet. I'm doing a final pass-through the spec file to validate grammar and previously added specs. I'll mark it as ready once all changes are complete.

@DarshitChanpura
Added missing response codes
415c990 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Merge remote-tracking branch 'upstream/main' into security-api-spec
f5b8fbb
@DarshitChanpura
Adds correct versions and fixes grammar in description field
fc988d9 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Adds entries in root file and fixes linter
95a6758 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@github-actions GitHub Actions
Copy link
Contributor

API specs implemented for 293/649 (45%) APIs.

@DarshitChanpura DarshitChanpura marked this pull request as ready for review May 1, 2024 15:03
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 1, 2024

API specs implemented for 299/649 (46%) APIs.

1 similar comment
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 1, 2024

API specs implemented for 299/649 (46%) APIs.

@DarshitChanpura
Re-arranges some more schemas
d1ba464 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 1, 2024

API specs implemented for 299/649 (46%) APIs.

@DarshitChanpura
Fixes a couple of descriptions
13360e2 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 1, 2024

API specs implemented for 299/649 (46%) APIs.

@DarshitChanpura
Copy link
Member Author

@dblock @nhtruong This PR is ready for review.

QQ, how are we planning to test the validity of all the added specs?

@DarshitChanpura
Copy link
Member Author

A new endpoint is in the process of being added to security plugin. I will update the spec once the PR is merged in security repo: opensearch-project/security#4299

@dblock dblock mentioned this pull request May 1, 2024
Closed
@dblock
Copy link
Member

dblock commented May 1, 2024

@dblock @nhtruong This PR is ready for review.

QQ, how are we planning to test the validity of all the added specs?

It's time for an issue!

#277

We do have a lot of tests in clients but we should add something here that exercises APIs.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 2, 2024

API specs implemented for 299/649 (46%) APIs.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 7, 2024

API specs implemented for 299/649 (46%) APIs.

@DarshitChanpura
Replace properties with additionalProperties for readability and flex…
a50b711 
…ibility

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 8, 2024

API specs implemented for 299/649 (46%) APIs.

@nhtruong
Copy link
Collaborator

nhtruong commented May 9, 2024

@Xtansia This looks good to me but would love a 2nd pair of eyes to review this.

Xtansia
Xtansia approved these changes May 10, 2024
View reviewed changes
Copy link
Collaborator

@Xtansia Xtansia left a comment

Choose a reason for hiding this comment

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

LGTM

@Xtansia Xtansia merged commit de939d2 into opensearch-project:main May 10, 2024
5 checks passed
@dblock dblock mentioned this pull request Jun 3, 2024
Open
@dblock
Copy link
Member

dblock commented Jun 4, 2024

@DarshitChanpura We have a new test framework in added in #299, maybe you'll be interested in writing tests for the security plugin using it?

@DarshitChanpura
Copy link
Member Author

@DarshitChanpura We have a new test framework in added in #299, maybe you'll be interested in writing tests for the security plugin using it?

Yes, I'll take a stab at it.

@DarshitChanpura DarshitChanpura mentioned this pull request Jun 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dblock dblock dblock left review comments

@nhtruong nhtruong nhtruong approved these changes

@Xtansia Xtansia Xtansia approved these changes

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@pgtgrly pgtgrly Awaiting requested review from pgtgrly

@sachetalva sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEATURE] Add specs for security namespace
4 participants
@DarshitChanpura @dblock @nhtruong @Xtansia