Updates "Using the API" page so it matches how developers look up Kibana Security APIs#5786
Merged
Conversation
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Vale Linting ResultsNo 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. |
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
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.
Summary
Updates Using the API (
solutions/security/detect-and-alert/using-the-api.md) so it matches how developers look up Kibana Security APIs, which is by searching for literal strings (path segments, group slugs, and doc paths) instead of long marketing-style link labels.Fixes #5797
Changes
endpoint-security-detections-apifor Stack and Serverless, and the docs pathsolutions/security/apisfor the broader Security APIs page.## API endpointswith subsections (Detection rules, Detection alerts, Exceptions and lists), similar to the APIs and tools pattern (Endpoint/ function-style tables).detection_engine/rules,detection_engine/rules/_find,exception_lists,lists), not fullMETHOD /api/...strings or generic “Stack” / “Serverless” labels.:::{table}with column width hints so the layout stays readable.Why
External developers often find APIs by pasting part of a path or slug into search. Aligning visible link text and headings with those literals makes the page easier to scan and matches the mental model they use in the API docs and in code.
Generative AI disclosure
Cursor + Composer 2 max