ResponseExample
Pin response code examples in the right-side panel beneath request examples.
For isolated previews, theme switching, and sandbox editing, open the ResponseExample playground on holydocs.com .
When to use
Use this component when endpoint documentation needs explicit request, response, schema, or lifecycle metadata.
This component is designed for the right-hand panel on endpoint pages. On narrow layouts it stacks later in the page, so verify both desktop and mobile behavior.
Live Examples
Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.
Basic
A JSON response example.
json{ "id": "proj_abc123", "name": "My Docs", "status": "active", "created_at": "2024-03-15T10:30:00Z"}
mdx<ResponseExample>```json{ "id": "proj_abc123", "name": "My Docs", "status": "active", "created_at": "2024-03-15T10:30:00Z"}```</ResponseExample>
Status Badge
Response example with a status code badge.
json{ "id": "proj_abc123", "status": "active"}
mdx<ResponseExample title="Created" statusCode="201">```json{ "id": "proj_abc123", "status": "active"}```</ResponseExample>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
title | string | -- | Optional label shown above the example. |
statusCode | string | -- | Optional HTTP status badge shown above the example. |
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<ResponseExample>```json{ "id": "proj_abc123", "name": "My Docs", "status": "active", "created_at": "2024-03-15T10:30:00Z"}```</ResponseExample>
Tips
- Show a realistic successful payload first, then link or follow with edge cases so readers can anchor on the happy path quickly.
- 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.
Related Components
Documents a request parameter — path, query, or body — with type, requirement status, and description.
More
- Interactive playground: ResponseExample on holydocs.com
- Component library index: /components