Skip to content

Updates "Using the API" page so it matches how developers look up Kibana Security APIs#5786

Merged
nastasha-solomon merged 3 commits into
mainfrom
update-endpoint-names
Apr 6, 2026
Merged

Updates "Using the API" page so it matches how developers look up Kibana Security APIs#5786
nastasha-solomon merged 3 commits into
mainfrom
update-endpoint-names

Conversation

@nastasha-solomon

@nastasha-solomon nastasha-solomon commented Apr 3, 2026

Copy link
Copy Markdown
Member

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

  • Intro cross-links — Replaced verbose titles (“Security detections API (Serverless)”, etc.) with short, searchable literals: the OpenAPI group slug endpoint-security-detections-api for Stack and Serverless, and the docs path solutions/security/apis for the broader Security APIs page.
  • Layout — Reorganized around ## API endpoints with subsections (Detection rules, Detection alerts, Exceptions and lists), similar to the APIs and tools pattern (Endpoint / function-style tables).
  • Tables — Three columns: Function | {{stack}} | {{serverless-full}}, with the same endpoint literal in each deployment column pointing at the correct Stack vs Serverless Kibana API reference.
  • Link text — Uses path-style names developers type or search for (for example detection_engine/rules, detection_engine/rules/_find, exception_lists, lists), not full METHOD /api/... strings or generic “Stack” / “Serverless” labels.
  • Presentation — Tables wrapped in :::{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

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Cursor + Composer 2 max

@nastasha-solomon nastasha-solomon self-assigned this Apr 3, 2026
@github-actions

github-actions Bot commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@github-actions

github-actions Bot commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

✅ Vale Linting Results

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.

@nastasha-solomon nastasha-solomon marked this pull request as ready for review April 3, 2026 23:40
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner April 3, 2026 23:40

@mdbirnstiehl mdbirnstiehl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

APPROVED!

@nastasha-solomon nastasha-solomon merged commit b0c20ac into main Apr 6, 2026
7 checks passed
@nastasha-solomon nastasha-solomon deleted the update-endpoint-names branch April 6, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update "Using the API" page so it matches how developers look up Kibana Security APIs

2 participants