[9.4] [Docs][Visualizations API] Add endpoint and field descriptions (#263151)#264423
Merged
Merged
Conversation
…ic#263151) ## Summary Part of the Lens Visualizations API documentation series. **Series:** - PR 1/4: Introduction and get-started overlay — merged (elastic#262595) - **PR 2/4 (this PR):** Endpoint descriptions and field descriptions - PR 3/4: Request code samples and response examples (elastic#262874) - Viz PR B: Chart type schema descriptions (elastic#263571) ## What changed ### Route files — all 5 endpoints Added `description` strings and `since: '9.4.0'` to all five routes. ### `schema/search.ts`, `schema/create.ts`, `schema/common.ts` - `query` search param: description added inline - `id` path param on delete/get/update: improved description - `total` response field: description added inline ### `schema/delete.ts`, `schema/get.ts`, `schema/update.ts` Updated `id` description to reference where the ID comes from. ### Shared package: `@kbn/as-code-shared-schemas` Added `meta.description` to all 7 fields of `asCodeMetaSchema` (`created_at`, `created_by`, `managed`, `owner`, `updated_at`, `updated_by`, `version`). > **Note:** descriptions added to `@kbn/content-management-utils` (`savedObjectSchema.id`, `searchOptionsSchemas.*`, `createOptionsSchemas.overwrite`) were **reverted** per feedback from ThomThomson — content management schemas are not part of the public as-code API surface. Descriptions for `fields`, `search_fields`, `overwrite`, and `id` will be handled via overlay fallback. ## Open items - Two CodeQL findings on `kbn-content-management-utils/src/schema.ts` (unbounded arrays) — pre-existing, not introduced by this PR - davismcphee's architectural question answered: content-management-utils changes reverted 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit c2bbbc4)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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.
Backport
This will backport the following commits from
mainto9.4:Questions ?
Please refer to the Backport tool documentation