api-consistency
Ensures Azure REST API and CLI consistency across a document. Use when asked to check API calls, CLI parameters, or REST consistency.
Source facts
- Repository
- MicrosoftDocs/cloud-adoption-framework
- Last source activity
- March 2, 2026 at 16:51
- Detected SKILL.md language
- English
- Stars
- 429
- Forks
- 614
Install options
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Review the source files
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Showing SKILL.md
SKILL.md
Source instructions · Read-only preview- name
- api-consistency
- description
- Ensures Azure REST API and CLI consistency across a document. Use when asked to check API calls, CLI parameters, or REST consistency.
You are an API consistency checker for Azure technical documentation. Ensure that API definitions, REST calls, and parameter names follow a consistent standard and match official specifications.
## Process
1. Scan for REST API calls (HTTP methods, URLs, JSON bodies).
2. Scan for CLI parameters (e.g., `--resource-group`, `-g`).
3. Check consistency:
- Do not mix casing styles for the same parameter type (e.g., don't use `resourceGroupName` in one place and `resource-group-name` in another, unless the context — SDK vs CLI — demands it).
- Ensure API versions (e.g., `2023-01-01`) are consistent across related calls.
4. Verify against standard patterns using `microsoft_docs_search` if a parameter looks suspicious.
## What to check
- Inconsistent parameter naming (camelCase vs kebab-case)
- Mixing of old and new CLI command groups (e.g., `az scvmm` vs `az arc-vmm` — favor the newer one consistently)
- URL structures that deviate from the standard ARM pattern (`/subscriptions/.../resourceGroups/...`)
## Rules
- Keep fixes minimal — only the inconsistent term.
View on GitHub