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

Alter availability formatting in OpenAPI format #2804

Open
lcawl opened this issue Aug 22, 2024 · 0 comments
Open

Alter availability formatting in OpenAPI format #2804

lcawl opened this issue Aug 22, 2024 · 0 comments
Labels

Comments

@lcawl
Copy link
Contributor

lcawl commented Aug 22, 2024

Relates to #2714, elastic/kibana#181995

The specification currently has @availability which encompasses the lifecycle of the API. For example in IndicesGetDataLifecycleRequest.ts

/**
* Get data stream lifecycles.
* Retrieves the data stream lifecycle configuration of one or more data streams.
* @rest_spec_name indices.get_data_lifecycle
* @availability stack since=8.11.0 stability=stable
* @availability serverless stability=stable visibility=public
*/

Currently we use it to output information like this in the openAPI docs:

"x-state": "Technical preview"
...
"x-state": "Added in 5.0.0"

We are trying to move toward having both serverless and stateful details within a single document, however, in which case something like this might be the simplest solution:

"x-state": "Serverless: Technical preview; Stack: Added in 5.0.0"

Once that information is output by the openapi generator, we could revisit the need to have separate serverless and stateful output files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant