api-design SKILL.md skillA
api-design from yonatangross/orchestkit is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add yonatangross/orchestkit/api-design@v2.0.0Pins v2.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- yonatangross/orchestkit
- Path
plugins/ork/skills/api-design/SKILL.md- Versions recorded
- 9
- Latest version
- v2.0.0, committed Oct 7, 2026
- First version recorded
- Jul 10, 2026
- Size
- 11,495 bytes
- Repository stars
- 296
- License
- MIT
API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows, RFC 9457 Problem Details error handling, and OpenAPI specs. Use when specifying the wire contract an endpoint exposes, choosing a versioning scheme, or standardizing error response bodies across services. Framework-agnostic protocol layer, not runtime implementation.
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 Comprehensive API design patterns covering REST/GraphQL framework design, versioning strategies, and RFC 9457 error handling. Each category has individual rule files in `rules/` loaded on-demand. ## Quick Reference | Category | Rules | Impact | When to Use | |----------|-------|--------|-------------| | [API Framework](#api-framework) | 3 | HIGH | REST conventions, resource modeling, OpenAPI specifications | | [Versioning](#versioning) | 2 | HIGH | URL path versioning, header versioning; deprecation windows are house policy in `references/ork-delta.md` | | [Error Handling](#error-handling) | 1 | HIGH | Agent-facing RFC 9457 extensions; base spec and FastAPI wiring are upstream | | [GraphQL](#graphql) | 2 | HIGH | Strawberry code-first, DataLoader, permissions, subscriptions | | [gRPC](#grpc) | 2 | HIGH | Protobuf services, streaming, interceptors, retry | | [Streaming](#streaming) | 2 | HIGH | SSE endpoints, WebSocket bidirectional, async generators | | [Integrations](#integrations) | 2 | HIGH | Messaging platforms (WhatsApp, Telegram), Payload CMS patterns | …
Read the whole file at its exact version.
How to install
mdr add yonatangross/orchestkit/api-design@sha256:c04a170d59cfa09fThe line at the top of this page pins the label v2.0.0, 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_ikgp47fyy2r5lbuq)
6 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 9 versions of this file, between Jul 10, 2026 and Oct 7, 2026, about one every 11 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v2.0.0 latest | 2026-10-07 | 480e358 | 11,495 B | A | view · diff |
| v2.0.0 | 2026-09-29 | 105a980 | 11,499 B | A | view · diff |
| v2.0.0 | 2026-09-28 | 220adb4 | 11,517 B | A | view · diff |
| v2.0.0 | 2026-09-20 | 02cb935 | 11,530 B | A | view · diff |
| v2.0.0 | 2026-08-29 | 2aed0b0 | 11,530 B | A | view · diff |
| v2.0.0 | 2026-07-31 | 0e6a3a8 | 11,530 B | A | view · diff |
| v2.0.0 | 2026-07-25 | 47b78fb | 9,599 B | A | view · diff |
| v2.0.0 | 2026-07-22 | f0f9557 | 9,599 B | A | view · diff |
| v2.0.0 | 2026-07-10 | 10a2d30 | 9,455 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 (11495 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
yonatangross/orchestkit · 296 stars · license MIT · pushed 2026-10-19 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ikgp47fyy2r5lbuq GET https://markdownregistry.com/api/v1/resolve?ref=yonatangross/orchestkit/api-design GET https://markdownregistry.com/api/v1/blob/c04a170d59cfa09f8c280b690476a02544b0092968f78d962dd883a2712b4080
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 yonatangross/orchestkit
Every file in yonatangross/orchestkit