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 PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #61

Merged

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 8, 2024

Coming from opensearch-project/opensearch-api-specification#387, update PR template to include a checkbox that requests that all API changes be documented in the OpenAPI spec used to generate clients.

@reta
Copy link
Contributor

reta commented Jul 9, 2024

Build should be fixed by #62

@dblock dblock force-pushed the update-pull-request-template branch from da31cc6 to e600b40 Compare July 11, 2024 20:42
@reta
Copy link
Contributor

reta commented Jul 16, 2024

@dblock could you rebase please? thank you

@dblock dblock force-pushed the update-pull-request-template branch from e600b40 to 31d5e1d Compare July 17, 2024 19:59
@dblock dblock requested a review from reta July 30, 2024 17:38
@andrross
Copy link
Member

andrross commented Aug 5, 2024

@dblock Eh, I'm not sure about this PR. I dislike unnecessary boilerplate, and it strikes me as unlikely that a repository plugin would ever need to implement a user-facing API that would require a change to the specification.

@dblock
Copy link
Member Author

dblock commented Aug 7, 2024

@andrross If you don't think this plugin will ever implement a REST API then we can just close it. Your call!

@andrross
Copy link
Member

andrross commented Aug 7, 2024

@andrross If you don't think this plugin will ever implement a REST API then we can just close it. Your call!

@dblock Upon further thought, repository implementations do define settings that go into the payload of a request to a core API and therefore are probably fair game for defining in the API specification.

@dblock dblock requested review from andrross and reta August 13, 2024 22:29
@dblock
Copy link
Member Author

dblock commented Aug 15, 2024

Can any current maintainers please merge this?

@samuel-oci @anasalkouz @VachaShah?

@andrross andrross merged commit 3a72493 into opensearch-project:main Aug 21, 2024
11 checks passed
@dblock dblock deleted the update-pull-request-template branch August 21, 2024 22:00
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.

3 participants