api-consistency

$npx mdskill add MicrosoftDocs/cloud-adoption-framework/api-consistency

Validate Azure documentation by enforcing consistent naming and structure across REST APIs and CLI commands.

  • Resolves discrepancies in parameter casing and naming across technical guides.
  • Analyzes Azure REST API calls and Azure CLI syntax patterns.
  • Compares usage against established standards, suggesting minimal necessary corrections.
  • Outputs precise, targeted fixes for inconsistent technical references.

SKILL.md

.github/skills/api-consistencyView on GitHub ↗
---
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.

More from MicrosoftDocs/cloud-adoption-framework

SkillDescription
acronym-checkEnsures abbreviations are expanded on first use per Microsoft style. Use when asked to check acronyms or abbreviations in documentation.
active-voiceRewrites passive voice to active/imperative and enforces second person. Use when asked to fix passive voice or improve writing directness.
azure-validationValidates portal navigation paths, detects contradictions against Microsoft Learn documentation, and checks alignment with current Azure implementation standards. Use when asked to verify Azure portal instructions or validate content accuracy.
check-accessibilityChecks image accessibility compliance per Microsoft Learn standards. Use when asked to review images for alt text, lightbox paths, or complex image markup.
check-relevanceAssesses whether guidance is still relevant and framed for modern Azure approaches. Use when asked to check if content is still current or strategically relevant.
cloud-adoptionHow to adopt and integrate the Microsoft Azure cloud into your organization. Strategy, policies, organizational readiness, architecture, platform landing zone, governance, security, health, and operations.
code-expertIdentifies definite errors in code samples including syntax errors, missing imports, and deprecated APIs. Use when asked to review code samples for correctness.
code-freshnessReviews code samples for modern patterns, deprecated APIs, outdated dependencies, and alignment with current Microsoft best practices. Use when asked to update or modernize code samples.
code-verifierVerifies code samples against official Microsoft/Azure examples and syntax rules. Use when asked to verify code correctness or validate API usage.
error-checkIdentifies severe factual errors in content. Use when asked to fact-check documentation for major inaccuracies.