api-versioning
API Versioning
Scope Boundaries
- Use when compatibility policy, deprecation lifecycle, or version transition strategy is in scope.
- Use proactively when API diffs alter semantics, required fields, response shape, or transport guarantees.
- Use when internal and external consumers have different support windows or migration constraints.
- Do not use for first-pass endpoint/schema design without change impact context.
- Do not use for storage internals; use
db-*.
Goal
Deliver explicit compatibility governance so consumers can migrate without surprises.
Shared API Contract (Canonical)
- Use
../api-design-rest/references/api-governance-contract.mdas the canonical contract. - Optional consistency checks (only if your repository enforces manifest validation):
python3 ../api-design-rest/scripts/validate_api_contract.py --manifest <path/to/manifest.json>
- Use API versioning templates in
../api-design-rest/assets/as baseline. - Use transport decision reference:
../api-design-rest/references/transport-selection-matrix.md
- Use threshold derivation reference:
../api-design-rest/references/threshold-derivation-framework.md
- Do not redefine breaking-change criteria, approval roles, or deprecation gates locally.
Implementation Templates
- Versioning policy template:
../api-design-rest/assets/api-versioning-policy-template.md
Inputs
- Current API surface and consumer adoption distribution
- Change classification (additive vs breaking)
- Regulatory, support-window, and migration constraints
- Audience split (
internal,external,both) and transport mix (rest,graphql,grpc,websocket,sse,queue)
Outputs
- Versioning policy (channel, semantics, compatibility guarantees)
- Deprecation and sunset plan with migration guidance
- Compatibility matrix linking producer versions and tested consumers
Workflow
- Classify changes using explicit breaking-change criteria from the canonical contract.
- Choose version channel (URI/header/media-type/schema tag) and publish scope boundaries.
- Split migration path for internal and external consumers when support windows differ.
- Define deprecation timeline and migration artifacts for affected consumers.
- Update compatibility matrix and ensure contract tests cover supported versions.
- Verify runbook and monitoring updates for dual-version operation periods.
- Validate artifact compliance against the canonical API contract.
Quality Gates
- Breaking changes include explicit migration plan and minimum deprecation window.
- Compatibility matrix is current for all supported consumer groups.
- Deprecation communication and sunset criteria are documented.
- Rollback and incident procedures are defined for version cutover periods.
Failure Handling
- Stop when breaking changes are proposed without migration path or deprecation evidence.
- Stop when supported consumer versions are unknown.
- Escalate when legal/compliance support windows cannot be met.
More from kentoshimizu/sw-agent-skills
graph-algorithms
Graph algorithm workflow for modeling entities/relations and selecting traversal, path, ordering, or flow strategies. Use when correctness or performance depends on graph representation and algorithm choice; do not use for schema-only modeling or deployment topology planning.
14bash-style-guide
Style, review, and refactoring standards for Bash shell scripting. Trigger when `.sh` files, files with `#!/usr/bin/env bash` or `#!/bin/bash`, or CI workflow blocks with `shell: bash` are created, modified, or reviewed and Bash-specific quality controls (quoting safety, error handling, portability, readability) must be enforced. Do not use for generic POSIX `sh`, PowerShell, or language-specific application style rules. In multi-language pull requests, run together with other applicable `*-style-guide` skills.
11architecture-clean-architecture
Clean Architecture workflow for enforcing dependency direction, stable domain boundaries, and use-case-centered application design. Use when teams must separate business rules from frameworks and delivery mechanisms; do not use for isolated module cleanup without boundary implications.
11powershell-style-guide
Style, review, and refactoring standards for PowerShell scripting. Trigger when `.ps1`, `.psm1`, `.psd1` files, or CI workflow blocks with `shell: pwsh` or `shell: powershell` are created, modified, or reviewed and PowerShell-specific quality controls (error handling, parameter validation, readability, operational safety) must be enforced. Do not use for Bash, generic POSIX `sh`, or language-specific application style rules. In multi-language pull requests, run together with other applicable `*-style-guide` skills.
10github-codeowners-management
Govern CODEOWNERS rules so review routing reflects real ownership and risk boundaries on GitHub. Use when repository ownership mapping or mandatory reviewer rules must be defined, updated, or audited; do not use for non-GitHub runtime architecture or data-layer design.
9security-authentication
Security workflow for authentication architecture, credential lifecycle, and session/token assurance. Use when login, identity proofing, MFA, or session security decisions are required; do not use for authorization policy design or non-security quality tuning.
9