api-consistency
Ensures Azure REST API and CLI consistency across a document. Use when asked to check API calls, CLI parameters, or REST consistency.
Informations de source
- Dépôt
- MicrosoftDocs/cloud-adoption-framework
- Dernière activité de la source
- 2 mars 2026 à 16:51
- Langue détectée de SKILL.md
- anglais
- Étoiles
- 431
- Forks
- 615
Options d'installation
Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.
Vérifiez les fichiers source
Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.
Affichage de SKILL.md
SKILL.md
Instructions source · Aperçu en lecture seule- 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.
Voir sur GitHub