Document parameter-level availability in Kibana API docs quickstart#7207
Open
leemthompo wants to merge 1 commit into
Open
Document parameter-level availability in Kibana API docs quickstart#7207leemthompo wants to merge 1 commit into
leemthompo wants to merge 1 commit into
Conversation
Field-level availability metadata is now supported (elastic/kibana#259125), so the "route level only / document in the description" guidance is outdated. - Add the parameter/property-level `meta.availability` approach with an example - Correct the stability values to experimental, tech_preview, and stable, with the labels each renders as - Note that the version is included in the stack docs and omitted from serverless Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
| - **`since`**: The version when the API was first added (for example, `'9.2.0'`) | ||
| - **`stability`**: Sets the lifecycle state. The value maps to the label shown in the API docs. | ||
| - `'experimental'` renders as **Experimental**. The API can change or be removed in future versions. | ||
| - `'tech_preview'` renders as **Technical Preview**. |
Member
There was a problem hiding this comment.
The tag is all capitals, so this doesn’t really matter, but maybe this could be sentence case for consistency with Generally available on line 100?
vishaangelova
approved these changes
Jul 4, 2026
vishaangelova
left a comment
vishaangelova
left a comment
Member
There was a problem hiding this comment.
Thanks, much awaited changes:) 🚀
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
The Kibana API docs quickstart said the
availabilityoption is only available at the route level, and that per-parameter version and lifecycle info had to be hand-written into the description. That's no longer true — field-levelavailabilitymetadata is now supported.This updates the code-generated section to:
meta.availabilityapproach, with an example.stabilityvalues toexperimental,tech_preview, andstable, and show the label each one renders as (Experimental, Technical Preview, Generally available). The old text listed only two values and mappedexperimentalto "Technical preview".sinceversion appears in the stack docs and is omitted from the serverless docs.Reference
converseparams to field-levelmeta.availability. CI-regenerated OAS confirmsx-staterenders per-property (version included inkibana.yaml, stripped inkibana.serverless.yaml).🤖 Generated with Claude Code