api-design SKILL.md skillA
api-design from intrafind/ihub-apps is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add intrafind/ihub-apps/api-design@git:20261107.26be12aPins git:20261107.26be12a in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- intrafind/ihub-apps
- Path
.claude/skills/api-design/SKILL.md- Versions recorded
- 4
- Latest version
- git:20261107.26be12a, committed Nov 7, 2026
- First version recorded
- Nov 6, 2026
- Size
- 4,367 bytes
- Repository stars
- 26
- License
- a license file GitHub does not identify
REST conventions for iHub's HTTP API — URL naming, `_action` segments, status codes, RFC 9457 error bodies, cursor pagination, compatibility. Auto-invoked when adding or changing a route handler, an endpoint's request or response shape, or an error response.
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
The canonical rules are in **`docs/api-guidelines.md`**; read it for the reasoning and the deviations from the
Zalando guidelines. This is the working summary. For input validation and path safety use the `api-security` skill.
## Before you write the handler
1. Write the OpenAPI comment first: request, success body, and every error `code` the endpoint can answer with.
2. Check the checklist at the end of `docs/api-guidelines.md`.
## Rules
**URLs.** Plural nouns, kebab-case, no verbs, at most two nesting levels. Query, path and body names are camelCase.
IDs are generated by the server and opaque.
**Actions.** Anything that is not create/read/update/delete is a path segment prefixed with `_`:
`POST /scheduled-tasks/{taskId}/_duplicate`, `POST /scheduled-tasks/_preview`, `GET /scheduled-tasks/_notifications`.
Prefer a resource (`POST …/runs`) when one models the operation. Never a bare `/run`, `/cancel`, `/rotate`.
(`scheduledTasks.js` is the reference.)
**Status codes.** `GET` 200 · `POST` create 201 + `Location` · `PUT`/`PATCH` 200 with the resource · `DELETE` 204 ·
…Read the whole file at its exact version.
How to install
mdr add intrafind/ihub-apps/api-design@sha256:d467e2bc1730aea9The line at the top of this page pins the label git:20261107.26be12a, 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_xbcqiljlmvqfukdf)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Nov 6, 2026 and Nov 7, 2026, more than one a day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261107.26be12a latest | 2026-11-07 | 26be12a | 4,367 B | A | view · diff |
| git:20261106.b984c2f | 2026-11-06 | b984c2f | 4,093 B | A | view · diff |
| git:20261106.c7122f2 | 2026-11-06 | c7122f2 | 4,094 B | A | view · diff |
| git:20261106.206f5e9 | 2026-11-06 | 206f5e9 | 3,523 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 (4367 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
intrafind/ihub-apps · 26 stars · license a license file GitHub does not identify · pushed 2026-11-07 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_xbcqiljlmvqfukdf GET https://markdownregistry.com/api/v1/resolve?ref=intrafind/ihub-apps/api-design GET https://markdownregistry.com/api/v1/blob/d467e2bc1730aea95f517569f042121fcba325095527484264896a5c7aee5af7
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 intrafind/ihub-apps
Every file in intrafind/ihub-apps