api-versioning-policy SKILL.md skillA

api-versioning-policy from samber/developer-platform-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add samber/developer-platform-skills/api-versioning-policy@v1.0.3

Pins v1.0.3 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
samber/developer-platform-skills
Path
skills/api-versioning-policy/SKILL.md
Versions recorded
9
Latest version
v1.0.3, committed Oct 25, 2026
First version recorded
Aug 28, 2026
Size
26,806 bytes
Repository stars
9
License
MIT

Define the versioning and deprecation policy for an API - version scheme choice (URI path, header, date-based account-pinned, or deliberate no-versioning), a written breaking-change definition, deprecation notice windows by audience, sunset communication (RFC 9745 Deprecation and RFC 8594 Sunset headers), enforcement at the sunset date (fall-forward vs hard cutoff), and breaking-change governance, with REST version-and-sunset and GraphQL continuous schema evolution treated as separate policies.

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 Policy

You are an API lifecycle strategist. A written versioning and deprecation policy covers:

- Which scheme carries the version.
- What counts as a breaking change.
- How long consumers get before a version dies.
- How you communicate and enforce that death.
- Who signs off on breaking anything.

The hard half is not choosing a scheme - "choosing a versioning strategy is the easy half. The hard half is removing a version without breaking the consumers still on it."

This skill owns the policy: it decides what the scheme and its lifecycle rules are. Sibling `samber/developer-platform-skills@public-api-design-review` only checks at review time that a scheme exists and is applied consistently.

Pre-GA stages (private and public preview, beta) and retiring one preview version for the next belong to `samber/developer-platform-skills@api-beta-program`, which reuses this skill's breaking-change definition. A beta surface enters this policy at GA.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add samber/developer-platform-skills/api-versioning-policy@sha256:08a337112d24edf5

The line at the top of this page pins the label v1.0.3, 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_tduh7mlwmc6l3shh.svg)](https://markdownregistry.com/a/art_tduh7mlwmc6l3shh)

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

Versions

The registry has recorded 9 versions of this file, between Aug 28, 2026 and Oct 25, 2026, about one every 7 days.

versioncommittedcommitsizeaudit
v1.0.3 latest2026-10-25 c2af680 26,806 BA view · diff
v1.0.32026-10-24 ef50f0b 26,628 BA view · diff
v1.0.22026-10-22 10c4795 26,489 BA view · diff
v1.0.12026-10-22 846d310 26,489 BA view · diff
v1.0.12026-10-21 86e91cf 26,235 BA view · diff
v1.0.12026-10-20 a2a893c 26,064 BA view · diff
v1.0.12026-09-27 3f8efdb 25,886 BA view · diff
v1.0.02026-08-28 5ae4759 25,483 BA view · diff
v1.0.02026-08-28 3f5bd2b 25,480 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 (26806 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

samber/developer-platform-skills · 9 stars · license MIT · pushed 2026-11-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_tduh7mlwmc6l3shh
GET https://markdownregistry.com/api/v1/resolve?ref=samber/developer-platform-skills/api-versioning-policy
GET https://markdownregistry.com/api/v1/blob/08a337112d24edf5ccc1856045726eacdea22b787078ec327e90f20b568b2c62

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 samber/developer-platform-skills

agent-integration-surfaces SKILL.md skill
samber/developer-platform-skills · skills/agent-integration-surfaces/SKILL.md · Plans how a SaaS or developer platform opens itself to AI agents, provider side - which agent classes may reach which…
v1.0.0 · audit A · 9 stars
agent-skill-offering SKILL.md skill
samber/developer-platform-skills · skills/agent-skill-offering/SKILL.md · Ships an Agent Skill (SKILL.md) inside the GitHub repo of the library, CLI or SDK it documents, versioned with the code…
v1.0.2 · audit A · 9 stars
api-auth-key-management SKILL.md skill
samber/developer-platform-skills · skills/api-auth-key-management/SKILL.md · Design the API-key authentication surface a platform issues to its own API consumers - key format with prefix+checksum…
v1.0.2 · audit A · 9 stars
api-beta-program SKILL.md skill
samber/developer-platform-skills · skills/api-beta-program/SKILL.md · Runs an early-access, preview, beta or design-partner program for a new API feature: program shape, what each pre-GA…
v1.0.1 · audit A · 9 stars
api-changelog-automation SKILL.md skill
samber/developer-platform-skills · skills/api-changelog-automation/SKILL.md · Designs the provider-side pipeline that turns contract diffs of an API you publish (OpenAPI, GraphQL SDL, protobuf…
v1.0.1 · audit A · 9 stars
api-error-design SKILL.md skill
samber/developer-platform-skills · skills/api-error-design/SKILL.md · Design the error surface of a public API so integrators self-serve fixes - a machine-readable error-code taxonomy (flat…
v1.0.2 · audit A · 9 stars
api-idempotency-retry SKILL.md skill
samber/developer-platform-skills · skills/api-idempotency-retry/SKILL.md · Design idempotency-key support and client retry guidance for a public API so integrators retry safely - key derivation…
v1.0.1 · audit A · 9 stars
api-integration-surface-strategy SKILL.md skill
samber/developer-platform-skills · skills/api-integration-surface-strategy/SKILL.md · Decide which integration surfaces a platform offers external developers and AI agents - REST, GraphQL, gRPC, SQL…
v1.0.4 · audit A · 9 stars
api-rate-limit-policy SKILL.md skill
samber/developer-platform-skills · skills/api-rate-limit-policy/SKILL.md · Design the rate-limit policy a public API publishes to its consumers - the metering model per paradigm (REST request…
v1.0.1 · audit A · 9 stars
api-reference-quality SKILL.md skill
samber/developer-platform-skills · skills/api-reference-quality/SKILL.md · Audit a published API reference at the endpoint level against its spec surface - every operation, parameter, response…
v1.0.2 · audit A · 9 stars
api-status-communication SKILL.md skill
samber/developer-platform-skills · skills/api-status-communication/SKILL.md · Design how an API platform communicates status and incidents to external consumers - status-page modeling (the…
v1.0.1 · audit A · 9 stars
api-test-mode-design SKILL.md skill
samber/developer-platform-skills · skills/api-test-mode-design/SKILL.md · Design the test/sandbox mode of a public API platform so external integrators build and validate without touching real…
v1.0.2 · audit A · 9 stars

Every file in samber/developer-platform-skills

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