API contract design and OpenAPI 3.1 specification skill. Enforces RFC 7807 problem details, idempotency headers, and consistent status codes.
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 Contract Design & OpenAPI 3.1 (`/api-design`)
> **Philosophy**: *APIs are permanent contracts. Design first. Standardize errors with RFC 7807. Enforce idempotency on state-changing operations. Paginate with cursors, never unbounded offsets.*
This skill establishes API contract standards, RESTful resource modeling, OpenAPI 3.1 specifications, uniform error semantics, and backward-compatibility rules.
---
## 1. Quick Navigation & Progressive Disclosure
| Resource Type | Document | Description |
| :--- | :--- | :--- |
| **Reference** | [references/rfc-7807-problem-details.md](references/rfc-7807-problem-details.md) | Standardized error schemas, type URIs, problem detail envelopes. |
| **Reference** | [references/idempotency-and-versioning.md](references/idempotency-and-versioning.md) | Idempotency keys, state caching, URI versioning, deprecation headers. |
| **Utility** | [scripts/validate_openapi_spec.py](scripts/validate_openapi_spec.py) | CLI linter auditing OpenAPI specs for RFC 7807 compliance and security schemes. |
---
## 2. RESTful Contract Architecture
```mermaid
flowchart LR
A["Client Request (+ Idempotency-Key)"] --> B["OpenAPI 3.1 Route Definition"]
…
The line at the top of this page pins the label git:20261029.1aa6bef, 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.
GET https://markdownregistry.com/api/v1/artifacts/art_27q5opzd3uvxah62
GET https://markdownregistry.com/api/v1/resolve?ref=darknecrocities/skillbuilder/.cursor/rules/api-design.mdc
GET https://markdownregistry.com/api/v1/blob/fae658176283396b9a2fdd492edbda83841c712805e6f00b284fa5410eabc1b3
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.
darknecrocities/skillbuilder · .cursor/rules/ai.mdc · Architect, implement, and maintain production AI systems, Gemini API agents, Antigravity multi-agent orchestration…
affaan-m/ecc · docs/es/skills/api-design/SKILL.md · Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de…
ericrisco/rsc-harness · skills/api-design/SKILL.md · Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL…
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API wire contracts for REST and GraphQL: resource shape, versioning and deprecation, RFC 9457 errors, OpenAPI. Use when…