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

[PROPOSAL] Add a checkbox in each plugin's PR templates to update API specs #387

Closed
22 tasks done
dblock opened this issue Jul 8, 2024 · 1 comment
Closed
22 tasks done
Assignees
Labels
enhancement New feature or request

Comments

@dblock
Copy link
Member

dblock commented Jul 8, 2024

What/Why

What are you proposing?

The same as opensearch-project/OpenSearch#13621 in each plugin.

What users have asked for this feature?

All users of OpenSearch that use language clients.

What problems are you trying to solve?

From opensearch-project/OpenSearch#13619

With the introduction of OpenSearch API Specification for generating client libraries and documentation in multiple languages, it is possible that new features might miss out on defining the APIs, leading in gaps in what the generated clients for exotic languages can support.

What is the developer experience going to be?

Create companion PRs for every API change with an OpenAPI spec and a test.

Dependent PRs

@dblock dblock added the enhancement New feature or request label Jul 8, 2024
@dblock dblock removed the untriaged label Jul 8, 2024
This was referenced Jul 8, 2024
@dblock dblock self-assigned this Jul 8, 2024
@dblock dblock pinned this issue Jul 17, 2024
@dblock
Copy link
Member Author

dblock commented Aug 22, 2024

This is done! cc: @vamshin

@dblock dblock closed this as completed Aug 22, 2024
@dblock dblock unpinned this issue Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants