api-design-document SKILL.md skillA
api-design-document from fattain-naime/engineering-docs is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add fattain-naime/engineering-docs/api-design-document@git:20260717.2f82174Pins git:20260717.2f82174 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- fattain-naime/engineering-docs
- Path
skills/api-design-document/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260717.2f82174, committed Jul 17, 2026
- First version recorded
- Jul 8, 2026
- Size
- 15,771 bytes
- Repository stars
- 6
- License
- MIT
Design a production-ready API specification aligned with OpenAPI 3.1 standards. Covers resource modeling, endpoint design, request/response contracts, authentication, versioning strategy, error handling, rate limiting, and pagination. Use when designing a new REST, GraphQL, or event-driven API.
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
## Purpose Produce an API design document that defines the complete interface contract for a new or revised API. This document is the authoritative specification that drives implementation, consumer integration, testing, and documentation simultaneously. **The cost of a bad API design is permanent.** Once consumers depend on it, changes are breaking changes. Getting the design right before the first line of implementation code is written is the highest-ROI investment in an API's lifetime. ## Input **Works best with:** The name of the API or service being designed. **Also valuable:** The domain entities and operations, consumer use cases, authentication context, existing API conventions in the codebase, performance requirements. **Example invocation:** `Design the API for a payment links system. Merchants create payment links with a custom amount, expiry, and description. Customers use the link to pay. Merchants can list, deactivate, and delete their links. Needs HMAC webhook notification on payment. Auth via Bearer token.` ## Key Concepts ### Richardson Maturity Model Target Level 2 or Level 3 (HATEOAS for discovery-driven APIs): …
Read the whole file at its exact version.
How to install
mdr add fattain-naime/engineering-docs/api-design-document@sha256:8f38cb88e803a87eThe line at the top of this page pins the label git:20260717.2f82174, 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_kso36btapxu3ytz2)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Jul 8, 2026 and Jul 17, 2026, about one every 2 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260717.2f82174 latest | 2026-07-17 | 2f82174 | 15,771 B | A | view · diff |
| git:20260712.59c5852 | 2026-07-12 | 59c5852 | 5,654 B | A | view · diff |
| git:20260712.7e3d1bb | 2026-07-12 | 7e3d1bb | 5,752 B | A | view · diff |
| git:20260709.03fe43c | 2026-07-09 | 03fe43c | 5,536 B | A | view · diff |
| git:20260708.a309efd | 2026-07-08 | a309efd | 4,720 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 (15771 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
fattain-naime/engineering-docs · 6 stars · license MIT · pushed 2026-10-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_kso36btapxu3ytz2 GET https://markdownregistry.com/api/v1/resolve?ref=fattain-naime/engineering-docs/api-design-document GET https://markdownregistry.com/api/v1/blob/8f38cb88e803a87e9b83165a86aafed08f3ec46ef9a9b7f597eb2a3ef7e7c4f5
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.