api-design-standards SKILL.md skillA
api-design-standards from aethrox/doctrine is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add aethrox/doctrine/api-design-standards@git:20260809.2a45dbbPins git:20260809.2a45dbb in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- aethrox/doctrine
- Path
skills/api-design-standards/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260809.2a45dbb, committed Aug 9, 2026
- First version recorded
- Aug 9, 2026
- Size
- 5,813 bytes
- Repository stars
- 19
- License
- MIT
API design discipline grounded in the Microsoft/Google REST guidelines, resource and URL conventions, a chosen versioning strategy, what counts as a backward-compatible vs breaking change, and consumer-driven contract testing. Use when designing a new API endpoint, changing an existing API's request/response shape, deciding how to version an API, or asking whether a change to a public interface is breaking.
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 Design Standards
An API is a promise to callers you don't control and usually can't see. Adding to that promise is free; changing or removing part of it breaks someone who already depended on it. Every API change is classified against that promise (additive or breaking) before it ships, not discovered after a caller files a bug.
## Phase 1: Resource and URL conventions
- URLs name **resources** (nouns), never actions (verbs): `POST /orders`, not `POST /createOrder`. The HTTP method carries the verb.
- Collections are plural (`/orders`), a specific member is the collection plus an identifier (`/orders/{id}`), and nesting reflects real ownership (`/orders/{id}/items`), not an arbitrary path someone found convenient.
- HTTP methods map to a fixed meaning, and only that meaning: `GET` (read, no side effects, safe to retry and cache), `POST` (create, or a non-idempotent action), `PUT` (full replace, idempotent, calling it twice with the same body leaves the same state), `PATCH` (partial update), `DELETE` (remove, idempotent).
…Read the whole file at its exact version.
How to install
mdr add aethrox/doctrine/api-design-standards@sha256:72c568360354caddThe line at the top of this page pins the label git:20260809.2a45dbb, 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.
[](https://markdownregistry.com/a/art_giz6gfsdemzeri66)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, all committed on Aug 9, 2026.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260809.2a45dbb latest | 2026-08-09 | 2a45dbb | 5,813 B | A | view · diff |
| git:20260809.5c2aad2 | 2026-08-09 | 5c2aad2 | 5,717 B | A | view · diff |
| git:20260809.21f29b0 | 2026-08-09 | 21f29b0 | 5,771 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (5813 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
aethrox/doctrine · 19 stars · license MIT · pushed 2026-09-11 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_giz6gfsdemzeri66 GET https://markdownregistry.com/api/v1/resolve?ref=aethrox/doctrine/api-design-standards GET https://markdownregistry.com/api/v1/blob/72c568360354cadd7dedf6c3460e24d2ae257a0c7121846b8f6f2cb53139e591
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.