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

Generate OpenAPI definitions automatically from Go code #761

Open
jsoriano opened this issue Oct 27, 2021 · 3 comments
Open

Generate OpenAPI definitions automatically from Go code #761

jsoriano opened this issue Oct 27, 2021 · 3 comments
Labels
good first issue Good for newcomers Team:Ecosystem Label for the Packages Ecosystem team

Comments

@jsoriano
Copy link
Member

There is an openAPI definition available in the repository, but there is nothing checking that it is maintained up to date with the actual implementation.

Consider strategies to maintain this definition updated.

@mtojek
Copy link
Contributor

mtojek commented May 11, 2022

QQ: Do we know if anyone uses the OpenAPI posted in the package-registry? If we know that it's outdated/incorrect/not usable, maybe it's better to remove it and:

  1. Leave another issue to support any kind of generation.
  2. Forget about it.

@jsoriano
Copy link
Member Author

+1 to remove it by now if not used (or not usable).

I would keep an open issue about providing an OpenAPI definition or something similar. I think this would be a nice to have, and can be also helpful for us to generate documentation.

@jsoriano
Copy link
Member Author

FTR, it seems there was a discussion about using registry's open API in Kibana/Fleet, but it was discarded: elastic/kibana#70711

@mtojek mtojek changed the title Ensure that OpenAPI definition is synchronized with actual implementation Generate OpenAPI definitions automatically from Go code May 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers Team:Ecosystem Label for the Packages Ecosystem team
Projects
None yet
Development

No branches or pull requests

3 participants