Drop camelCase operationId rule from the API docs checklist - #8403
Open
florent-leborgne wants to merge 1 commit into
Open
florent-leborgne wants to merge 1 commit into
florent-leborgne wants to merge 1 commit into
Conversation
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>
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. |
florent-leborgne
enabled auto-merge
September 21, 2026 08:56
This branch was successfully deployed
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
Follow-up to #8353 and the post-merge review on that PR, which flagged kebab-case Kibana
operationIdguidance 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:
create-dashboard,async-search-get).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-resourcerule stays on the Kibana API docs quickstart.Test plan
Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6
Made with Cursor