api-error-patterns SKILL.md skillA

api-error-patterns from jartan-llc/grimoire is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add jartan-llc/grimoire/api-error-patterns@git:20260731.f6add68

Pins git:20260731.f6add68 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
jartan-llc/grimoire
Path
plugins/praxis/skills/api-error-patterns/SKILL.md
Versions recorded
4
Latest version
git:20260731.f6add68, committed Jul 31, 2026
First version recorded
Jun 18, 2026
Size
1,610 bytes
Repository stars
3
License
MIT

API error response format -- machine-readable codes, human-readable reasons, status code rules.

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 Error Conventions

## Response Format

All API error responses use a consistent format:

```json
{
  "detail": {
    "code": "UPPER_SNAKE_CASE_CODE",
    "reason": "Human-readable message."
  }
}
```

- **`code`**: Machine-readable identifier. Frontend uses this for branching logic (redirect to verification, show specific field errors).
- **`reason`**: User-facing message. Frontend can display directly. Always a complete sentence ending with a period.

## Status Code Rules

| Status | When to Use |
|--------|-------------|
| 200 | Successful operation that returns data |
| 201 | Resource created |
| 204 | Success with no body (logout, delete, disable) |
| 400 | Client sent bad data (invalid input, bad credentials) |
| 403 | Authenticated but forbidden (wrong password, disabled feature, insufficient role) |
| 404 | Resource not found |
| 409 | Conflict (duplicate resource) |
| 429 | Too many requests (rate limit exceeded) |
| 500 | Unexpected server error (never intentional except for genuine internal failures) |

## Adding New Error Codes

1. Use the `{"code": "...", "reason": "..."}` format
2. Reuse an existing code if the error is semantically identical
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add jartan-llc/grimoire/api-error-patterns@sha256:1d1fffe5082790fc

The line at the top of this page pins the label git:20260731.f6add68, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_7nafz645wpdhmaty.svg)](https://markdownregistry.com/a/art_7nafz645wpdhmaty)

1 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 4 versions of this file, between Jun 18, 2026 and Jul 31, 2026, about one every 15 days.

versioncommittedcommitsizeaudit
git:20260731.f6add68 latest2026-07-31 f6add68 1,610 BA view · diff
git:20260705.faf6c3f2026-07-05 faf6c3f 1,588 BA view · diff
git:20260618.9d9291d2026-06-18 9d9291d 1,589 BA view · diff
git:20260618.bd16f672026-06-18 bd16f67 1,611 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (1610 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

GitHub

jartan-llc/grimoire · 3 stars · license MIT · pushed 2026-10-31 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_7nafz645wpdhmaty
GET https://markdownregistry.com/api/v1/resolve?ref=jartan-llc/grimoire/api-error-patterns
GET https://markdownregistry.com/api/v1/blob/1d1fffe5082790fc70ed3f37c337d7cc6d6203b21a5e6a28a44c53780e28a44e

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 jartan-llc/grimoire

AGENTS.md AGENTS.md file
jartan-llc/grimoire · AGENTS.md
git:20261027.93a0cf9 · audit A · 3 stars
CLAUDE.md CLAUDE.md file
jartan-llc/grimoire · CLAUDE.md
git:20261023.fc78225 · audit B · 3 stars
claude-config SKILL.md skill
jartan-llc/grimoire · plugins/claudivis/skills/claude-config/SKILL.md · How agents, skills, and commands work in Claude Code projects.
git:20261023.fc78225 · audit A · 3 stars
commit-pr-writing SKILL.md skill
jartan-llc/grimoire · plugins/gitwise/skills/commit-pr-writing/SKILL.md · What a commit message, a PR title and a PR description say, and which of them lands on the default branch under…
git:20261023.fc78225 · audit A · 3 stars
github-conventions SKILL.md skill
jartan-llc/grimoire · plugins/gitwise/skills/github-conventions/SKILL.md · GitHub conventions -- branch naming, commit format, issue/PR templates, and safe issue/PR referencing in comments.
git:20261029.bd8879e · audit A · 3 stars
address-review SKILL.md skill
jartan-llc/grimoire · plugins/praxis/skills/address-review/SKILL.md · Work through review findings on a PR, or on a branch before it has one, one at a time
git:20261028.38332e5 · audit A · 3 stars
code-hygiene SKILL.md skill
jartan-llc/grimoire · plugins/praxis/skills/code-hygiene/SKILL.md · Language-agnostic code hygiene -- no dead/reinvented/duplicated code, truthful names, real implementations, and scoped…
git:20261023.fc78225 · audit A · 3 stars
code-structure SKILL.md skill
jartan-llc/grimoire · plugins/praxis/skills/code-structure/SKILL.md · Language-agnostic structural craft -- decompose on responsibility not size, prefer deep modules over shallow piles, and…
git:20261023.fc78225 · audit A · 3 stars
comment-hygiene SKILL.md skill
jartan-llc/grimoire · plugins/praxis/skills/comment-hygiene/SKILL.md · Comment truthfulness -- what a comment must tell the reader that the code can't, the KEEP/DELETE/EXEMPT/CONDITIONAL…
git:20261023.fc78225 · audit A · 3 stars
create-issue SKILL.md skill
jartan-llc/grimoire · plugins/praxis/skills/create-issue/SKILL.md · Create a GitHub issue using the appropriate template
git:20261023.fc78225 · audit A · 3 stars
create-pr SKILL.md skill
jartan-llc/grimoire · plugins/praxis/skills/create-pr/SKILL.md · Create a pull request for implemented changes from a GitHub issue
git:20261029.bf2c2ed · audit A · 3 stars
docs-patterns SKILL.md skill
jartan-llc/grimoire · plugins/praxis/skills/docs-patterns/SKILL.md · Documentation conventions -- doc types, structure, register, per-type rules, and quality standards.
git:20261023.fc78225 · audit A · 3 stars

Every file in jartan-llc/grimoire

Browse by kind, by grade A, or by owner.