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

Provide OpenAPI/Swagger specification out of the box #30081

Closed
elasticmachine opened this issue Aug 28, 2017 · 4 comments
Closed

Provide OpenAPI/Swagger specification out of the box #30081

elasticmachine opened this issue Aug 28, 2017 · 4 comments
Assignees
Labels
:Core/Infra/REST API REST infrastructure and utilities >docs General docs changes

Comments

@elasticmachine
Copy link
Collaborator

Original comment by @lcawl:

This issue is related to #25152

I have been formatting the X-Pack API reference information such that it uses the same section headers as the Cloud Enterprise documentation, which in turn was generated from Swagger.

I would like to pursue whether we can go one step further and start generating the X-Pack API information from Swagger too. This would help avoid situations where the documentation gets out of synch with the API code.

If it is not possible to include our current level of code snippet testing in the Swagger-generated files, we will need to investigate options for appending that information.

@elasticmachine
Copy link
Collaborator Author

Original comment by @lcawl:

Some information about how the Cloud team implemented this is here: LINK REDACTED

@elasticmachine elasticmachine added >docs General docs changes v7.0.0 labels Apr 25, 2018
@colings86 colings86 added the :Core/Infra/REST API REST infrastructure and utilities label Apr 25, 2018
@elasticmachine
Copy link
Collaborator Author

Pinging @elastic/es-core-infra

@javanna
Copy link
Member

javanna commented Mar 4, 2019

Should this be considered a duplicate of #25152 ?

@polyfractal polyfractal added v7.2.0 and removed v7.0.0 labels Apr 9, 2019
@jakelandis jakelandis added v7.3.0 and removed v7.2.0 labels Jun 17, 2019
@jpountz jpountz removed the v7.3.0 label Jul 5, 2019
@jrodewig
Copy link
Contributor

jrodewig commented Oct 4, 2019

[docs issue triage]

Closing as there are no current plans to provide OpenAPI/Swagger spec. More discussion at #25152.

Meanwhile, we've created the Elastic API Reference template as part of elastic/docs#937.

We're working to migrate Elasticsearch API Reference documentation to this template format as part of #45195.

@jrodewig jrodewig closed this as completed Oct 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/REST API REST infrastructure and utilities >docs General docs changes
Projects
None yet
Development

No branches or pull requests

8 participants