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

[Feature Request] Add TODO for Updating API Spec #13619

Closed
kkhatua opened this issue May 10, 2024 · 0 comments · Fixed by #13621
Closed

[Feature Request] Add TODO for Updating API Spec #13619

kkhatua opened this issue May 10, 2024 · 0 comments · Fixed by #13621
Assignees
@kkhatua
Labels
Clients Clients within the Core repository such as High level Rest client and low level client enhancement Enhancement or improvement to existing feature or request untriaged

Comments

@kkhatua
Copy link
Member

kkhatua commented May 10, 2024

Is your feature request related to a problem? Please describe

With the introduction of OpenSearch API Specification for generating client libraries and documentation in multiple languages
(See: https://github.com/opensearch-project/opensearch-api-specification?tab=readme-ov-file#welcome), 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.

Describe the solution you'd like

It would be good to have the pull request template include an item in its checklist for updating the API specs as a precondition to committing the feature.

Related component

Clients

Describe alternatives you've considered

N/A

Additional context

No response
@kkhatua kkhatua added enhancement Enhancement or improvement to existing feature or request untriaged labels May 10, 2024
@kkhatua kkhatua self-assigned this May 10, 2024
@github-actions github-actions bot added the Clients Clients within the Core repository such as High level Rest client and low level client label May 10, 2024
@kkhatua kkhatua mentioned this issue May 10, 2024
Merged
8 tasks
@dblock dblock mentioned this issue Jul 8, 2024
Closed
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kkhatua kkhatua

Labels
Clients Clients within the Core repository such as High level Rest client and low level client enhancement Enhancement or improvement to existing feature or request untriaged
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add TODO for Updating API Spec kkhatua/OpenSearch
1 participant
@kkhatua