ResponseField

Documents a field in an API response body with its name, type, and description.

For isolated previews, theme switching, and sandbox editing, open the ResponseField playground on holydocs.com .

When to use

Use this component when endpoint documentation needs explicit request, response, schema, or lifecycle metadata.

Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.

A standard response field.

idstring

Unique identifier for the project, prefixed with proj_.

mdx
<ResponseField name="id" type="string">  Unique identifier for the project, prefixed with `proj_`.</ResponseField>

Prop	Type	Default	Description
`name`	`string`	`field`	Field name as returned in the JSON response.
`type`	`string`	`string`	Data type of the response field.

Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.

mdx
<ResponseField name="id" type="string">  Unique identifier for the project, prefixed with `proj_`.</ResponseField>

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.

ParamField

Documents a request parameter — path, query, or body — with type, requirement status, and description.

Learn More

Expandable

Collapsible section for nested API fields, keeping complex response shapes readable.

Learn More

RequestExample

Pin request code examples in the right-side panel alongside API endpoint documentation.

Learn More

Was this page helpful?