api-versioning SKILL.md skillA

api-versioning from amey-thakur/ai-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add amey-thakur/ai-skills/api-versioning@git:20260720.1dc980e

Pins git:20260720.1dc980e in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
amey-thakur/ai-skills
Path
skills/backend/api-versioning/SKILL.md
Versions recorded
1
Latest version
git:20260720.1dc980e, committed Jul 20, 2026
Size
2,357 bytes
Repository stars
13
License
MIT

Version APIs so existing clients keep working while the contract evolves, with a real sunset process. Use when choosing a versioning scheme or planning a breaking API change.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# API versioning

The best version strategy is needing versions rarely: evolve additively,
and when you must break, break loudly, once, with a long runway.

## Method

1. **Exhaust additive evolution first.** New optional fields, new
   endpoints, new enum values (documented as open sets) are not breaking.
   Removing, renaming, retyping, tightening validation, changing defaults
   or error codes are. Keep the taxonomy written down where reviewers see
   it (see api-change-management).
2. **Pick URL-path versioning unless you have a reason.** `/v1/orders`
   is visible in logs, testable in a browser, cacheable, and impossible
   to send by accident. Header/date-based versioning (Stripe-style
   pinning) is strictly better ergonomics at much higher implementation
   cost; choose it deliberately, not aspirationally.
3. **Version the whole surface, not per endpoint.** `/v1/orders` with
   `/v2/refunds` forces every client to carry a compatibility matrix.
   One version number, moved rarely.
4. **Keep old versions thin, not forked.** Implement vN-1 as a translation
   layer over the vN core (request/response adapters), or the old version
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add amey-thakur/ai-skills/api-versioning@sha256:2170980b09d11152

The line at the top of this page pins the label git:20260720.1dc980e, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_ismb2y75pcufuaip.svg)](https://markdownregistry.com/a/art_ismb2y75pcufuaip)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Jul 20, 2026.

versioncommittedcommitsizeaudit
git:20260720.1dc980e latest2026-07-20 1dc980e 2,357 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (2357 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

amey-thakur/ai-skills · 13 stars · license MIT · pushed 2026-09-06 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_ismb2y75pcufuaip
GET https://markdownregistry.com/api/v1/resolve?ref=amey-thakur/ai-skills/api-versioning
GET https://markdownregistry.com/api/v1/blob/2170980b09d11152674313852709a20c174d292754aca70422385715bd00dcfe

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from amey-thakur/ai-skills

ai-skills Cursor rule
amey-thakur/ai-skills · .cursor/rules/ai-skills.mdc · Operate the AI-SKILLS library autonomously, selecting the right skill or prompt for each task.
git:20260721.9534dd9 · audit A · 13 stars
AGENTS.md AGENTS.md file
amey-thakur/ai-skills · AGENTS.md
git:20260728.aa354e7 · audit A · 13 stars
CLAUDE.md CLAUDE.md file
amey-thakur/ai-skills · CLAUDE.md
git:20260721.9534dd9 · audit A · 13 stars
llms.txt@docs llms.txt file
amey-thakur/ai-skills · docs/llms.txt
git:20260728.f55fde9 · audit B · 13 stars
llms.txt llms.txt file
amey-thakur/ai-skills · llms.txt
git:20260906.c8c8420 · audit B · 13 stars
accessibility-review SKILL.md skill
amey-thakur/ai-skills · skills/accessibility/accessibility-review/SKILL.md · Audit a UI for real accessibility, keyboard-first, with concrete failures and fixes rather than checkbox compliance…
git:20260718.7c1285c · audit A · 13 stars
accessible-forms SKILL.md skill
amey-thakur/ai-skills · skills/accessibility/accessible-forms/SKILL.md · Build forms with associated labels, identified errors, clear instructions, and autocomplete attributes. Use when…
git:20260728.fac4544 · audit A · 13 stars
alt-text-writing SKILL.md skill
amey-thakur/ai-skills · skills/accessibility/alt-text-writing/SKILL.md · Write alt text that conveys an image's purpose, marks decorative images empty, and handles functional and complex…
git:20260728.fac4544 · audit A · 13 stars
aria-usage SKILL.md skill
amey-thakur/ai-skills · skills/accessibility/aria-usage/SKILL.md · Use ARIA correctly by preferring native HTML, applying roles/states/properties only where needed, and following known…
git:20260728.fac4544 · audit A · 13 stars
color-contrast SKILL.md skill
amey-thakur/ai-skills · skills/accessibility/color-contrast/SKILL.md · Meet WCAG contrast ratios for text and non-text, never rely on color alone, and verify with tools including in dark…
git:20260728.fac4544 · audit A · 13 stars
focus-management SKILL.md skill
amey-thakur/ai-skills · skills/accessibility/focus-management/SKILL.md · Manage focus on route changes, in modals, and after actions, with visible focus indicators. Use when building…
git:20260728.fac4544 · audit A · 13 stars
keyboard-navigation SKILL.md skill
amey-thakur/ai-skills · skills/accessibility/keyboard-navigation/SKILL.md · Make interfaces fully keyboard-operable with logical focus order, no traps, skip links, and roving tabindex where…
git:20260728.fac4544 · audit A · 13 stars

Every file in amey-thakur/ai-skills

Other files named api-versioning

api-versioning SKILL.md skill
rrezartprebreza/spring-boot-skills · skills/spring-boot-3/api-versioning/SKILL.md · Use when versioning Spring MVC or WebFlux APIs in Spring Boot 3 / Spring Framework 6. Covers explicit URL, header, and…
git:20260807.5f992d7 · audit A · 338 stars
api-versioning SKILL.md skill
aniruddhadas1/oniroute_swarmagents · skills/official/backend/api-versioning/SKILL.md · Evolve external interfaces while protecting consumers and migration paths. Use when planning or reviewing api…
git:20260804.bc7d3a4 · audit A · 2 stars

Browse by kind, by grade A, or by owner.