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

[FEATURE] Generate API code from OpenSearch OpenAPI Spec #192

Open
Xtansia opened this issue Oct 10, 2023 · 2 comments
Open

[FEATURE] Generate API code from OpenSearch OpenAPI Spec #192

Xtansia opened this issue Oct 10, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@Xtansia
Copy link
Collaborator

Xtansia commented Oct 10, 2023

Is your feature request related to a problem?

Related to opensearch-project/opensearch-clients#19

What solution would you like?

Re-use the existing generator that generates API Code that maintains backwards compatibility with the current client APIs and provides a way to add new APIs.

Existing generator exists here: https://github.com/opensearch-project/opensearch-rs/tree/main/api_generator

It should be modified so that it parses the OpenAPI specification from https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json instead of the legacy "rest specs".

There's some documentation about how the specs map onto the generated code here: https://github.com/opensearch-project/opensearch-api-specification/blob/main/CLIENT_GENERATOR_GUIDE.md

What alternatives have you considered?

Using OpenAPI generators instead of re-using the existing generator but it makes it difficult to maintain backwards compatibility.

Do you have any additional context?

Add any other context or screenshots about the feature request here.

@Xtansia Xtansia added the enhancement New feature or request label Oct 10, 2023
@Xtansia Xtansia removed the untriaged label Oct 11, 2023
@Xtansia Xtansia changed the title [FEATURE] Generate API code from OpenSearch API Spec [FEATURE] Generate API code from OpenSearch OpenAPI Spec Oct 18, 2023
@AbhinavGarg90
Copy link
Contributor

Coming from #190, I'm interested to work on this. I am not sure where I start though. Is there anywhere you suggest I start reading to try to understand how to approach this?

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