ErrorSet

Structured container for documented API errors with meaning, common causes, and retry guidance.

For isolated previews, theme switching, and sandbox editing, open the ErrorSet 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.

Authentication Errors

Grouped 401 and 429 responses.

Common authentication failures
401

Unauthorized

do not retry blindly
Meaning

The request could not be authenticated, so no resource-specific validation was attempted.

Common causes
  • Missing bearer token
  • Expired access token
  • Token signed for another project
Retry guidance

Refresh the token or generate a new project-scoped key before retrying.

429

Rate limit exceeded

retryable
Meaning

Your client sent more authenticated requests than the current bucket allows in the active time window.

Common causes
  • Burst of parallel requests
  • Replayed webhook deliveries
Retry guidance

Back off using the Retry-After header and replay the request once capacity is available.

mdx
<ErrorSet title="Common authentication failures">  <StatusCode    code="401"    title="Unauthorized"    causes="Missing bearer token | Expired access token | Token signed for another project"    retry="Refresh the token or generate a new project-scoped key before retrying."    retryable={false}  >    The request could not be authenticated, so no resource-specific validation was attempted.  </StatusCode>  <StatusCode    code="429"    title="Rate limit exceeded"    causes="Burst of parallel requests | Replayed webhook deliveries"    retry="Back off using the Retry-After header and replay the request once capacity is available."    retryable  >    Your client sent more authenticated requests than the current bucket allows in the active time window.  </StatusCode></ErrorSet>

Props

PropTypeDefaultDescription
titlestring--Optional section title for the grouped errors.

Usage

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

mdx
<ErrorSet title="Common authentication failures">  <StatusCode    code="401"    title="Unauthorized"    causes="Missing bearer token | Expired access token | Token signed for another project"    retry="Refresh the token or generate a new project-scoped key before retrying."    retryable={false}  >    The request could not be authenticated, so no resource-specific validation was attempted.  </StatusCode>  <StatusCode    code="429"    title="Rate limit exceeded"    causes="Burst of parallel requests | Replayed webhook deliveries"    retry="Back off using the Retry-After header and replay the request once capacity is available."    retryable  >    Your client sent more authenticated requests than the current bucket allows in the active time window.  </StatusCode></ErrorSet>

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.
ParamField

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

Learn More
ResponseField

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

Learn More
Expandable

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

Learn More

More

Previous Schema
Next StatusCode
Ask a question... ⌘I