StatusCode
Standalone documented HTTP status card with meaning, common causes, and explicit retry guidance.
For isolated previews, theme switching, and sandbox editing, open the StatusCode playground on holydocs.com .
When to use
Use this component when endpoint documentation needs explicit request, response, schema, or lifecycle metadata.
Live Examples
Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.
Validation Error
Single detailed error card.
The server parsed the request successfully but rejected one or more fields because they failed schema or business-rule validation.
- Malformed JSON body
- Unknown enum value
- Missing required field
Correct the request payload and resend the same call.
mdx<StatusCode code="422" title="Validation failed" causes="Malformed JSON body | Unknown enum value | Missing required field" retry="Correct the request payload and resend the same call." retryable={false}>The server parsed the request successfully but rejected one or more fields because they failed schema or business-rule validation.</StatusCode>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
code | string | 400 | HTTP status code. |
title | string | -- | Short title for the failure mode. |
retry | string | -- | Recommended retry behavior. |
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<StatusCode code="422" title="Validation failed" causes="Malformed JSON body | Unknown enum value | Missing required field" retry="Correct the request payload and resend the same call." retryable={false}>The server parsed the request successfully but rejected one or more fields because they failed schema or business-rule validation.</StatusCode>
Tips
- Keep naming and ordering consistent across fields, examples, and lifecycle notes so readers do not have to re-parse the endpoint surface on every page.
- Document the happy path and the sharp edges together. Request shape alone is not enough without auth, errors, and retry guidance.
- If a component renders into the right panel, verify the page on desktop width so you can confirm the supporting example is visible where readers expect it.
Related Components
Documents a request parameter — path, query, or body — with type, requirement status, and description.
More
- Interactive playground: StatusCode on holydocs.com
- Component library index: /components