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

[OAS] Include x-availability-since for on-prem Kibana #188930

Open
jloleysens opened this issue Jul 23, 2024 · 2 comments
Open

[OAS] Include x-availability-since for on-prem Kibana #188930

jloleysens opened this issue Jul 23, 2024 · 2 comments
Labels
discuss Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@jloleysens
Copy link
Contributor

Original context, quoting @lcawl :

"
The Elasticsearch specifications now have a cool x-available-since qualifer per elastic/elasticsearch-specification#2655. Not sure how/if that could be added to the Kibana automation, but seems like a really cool bit of info for us to include in the docs.
...
...optionally added to the specification (which for Elasticsearch is maintained separately from the code) and is only applicable to on-prem per its description in https://github.com/elastic/elasticsearch-specification/blob/main/docs/add-new-api.md. I presume it's not necessary in serverless since we have version info in the headers. However in the on-prem scenario, I'm investigating whether this info in an x-availability-since property helps us get to a goal of fewer API doc versions.
"

@jloleysens jloleysens added discuss Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels Jul 23, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@jloleysens
Copy link
Contributor Author

jloleysens commented Jul 23, 2024

Not 100% clear (yet) this is something that will turn into a work item for the platform team at this stage, but I can see how we may want input from API owners in determining "available since".

@lcawl Is it possible this information could be captured in an overlay and the stack version scraped from git blame? Might be a bit tedious, but seems possible to do this for sets of APIs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

No branches or pull requests

2 participants