Skip to content

Drop camelCase operationId rule from the API docs checklist - #8403

Open
florent-leborgne wants to merge 1 commit into
mainfrom
flb/api-docs-operationid-casing
Open

florent-leborgne wants to merge 1 commit into
mainfrom
flb/api-docs-operationid-casing

Conversation

@florent-leborgne

Copy link
Copy Markdown
Member

Summary

Follow-up to #8353 and the post-merge review on that PR, which flagged kebab-case Kibana operationId guidance against this checklist's camelCase bullet.

The checklist is shared by Elasticsearch, Kibana, Logstash, and other API docs workflows. Replacing camelCase with kebab-case would still be wrong for some of them:

  • New Kibana public routes and Elasticsearch OpenAPI IDs use kebab-case (create-dashboard, async-search-get).
  • Older Kibana YAML APIs, Logstash, and Cloud still use camelCase (createCaseDefaultSpace, nodeInfoOS).

This PR drops the casing from the checklist. The linked Add operation identifiers page already requires unique, URL-safe, consistent IDs. Kibana's kebab-case verb-resource rule stays on the Kibana API docs quickstart.

Test plan

  • Preview the checklist bullet. Confirm it still links to Add operation identifiers and no longer names a case convention.

Generative AI disclosure

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

Tool(s) and model(s) used: Cursor Grok 4.6

Made with Cursor

That page covers every API docs workflow. A single casing rule is wrong for some products, so uniqueness stays here and product pages keep the naming convention.

Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne
florent-leborgne requested a review from a team as a code owner September 21, 2026 08:46
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@github-actions

Copy link
Copy Markdown
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.

This branch was successfully deployed

1 active deployment
docs-preview 53be9b3e Deployed Sep 21, 2026 by github-actions[bot]
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.

1 participant