Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist.

opensearch-project / opensearch-oci-object-storage

OpenSearch Repository Plugin For Oci Object Storage

Apache License 2.0

7 stars 19 forks source link

Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #61

Closed dblock closed 3 weeks ago

dblock commented 2 months ago

Coming from https://github.com/opensearch-project/opensearch-api-specification/issues/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 commented 2 months ago

Build should be fixed by https://github.com/opensearch-project/opensearch-oci-object-storage/pull/62

reta commented 1 month ago

@dblock could you rebase please? thank you

andrross commented 1 month ago

@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 commented 1 month ago

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

andrross commented 1 month ago

@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 commented 4 weeks ago

Can any current maintainers please merge this?

@samuel-oci @anasalkouz @VachaShah?