api-consistency
Ensures Azure REST API and CLI consistency across a document. Use when asked to check API calls, CLI parameters, or REST consistency.
Informações da origem
- Repositório
- MicrosoftDocs/cloud-adoption-framework
- Última atividade na origem
- 2 de março de 2026 às 16:51
- Idioma detectado do SKILL.md
- inglês
- Estrelas
- 431
- Forks
- 615
Opções de instalação
Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.
Revise os arquivos de origem
Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.
Exibindo SKILL.md
SKILL.md
Instruções da origem · Visualização somente leitura- 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.
Ver no GitHub