Endpoint

Compact operation header for method, path, auth requirements, rate limits, idempotency, SDK availability, and lifecycle metadata.

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

Create Project

Endpoint header with lifecycle metadata.

Create a project
POST /v1/projects
Auth: Bearer tokenRate limit: 60 requests / minuteIdempotency: Idempotency-Key header supportedSDKs: TypeScript, Python, GoSince: 2025-01-14

Creates a new project workspace and returns the project record with its generated identifier.

mdx
<Endpoint  title="Create a project"  method="POST"  path="/v1/projects"  auth="Bearer token"  rateLimit="60 requests / minute"  idempotency="Idempotency-Key header supported"  sdk="TypeScript | Python | Go"  since="2025-01-14">Creates a new project workspace and returns the project record with its generated identifier.</Endpoint>

Props

PropTypeDefaultDescription
methodstringGETHTTP method label.
pathstring/Endpoint path.
authstring--Authentication requirement summary.
rateLimitstring--Rate limit guidance shown as a chip.
sdkstring--Comma or pipe separated SDK list.

Usage

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

mdx
<Endpoint  title="Create a project"  method="POST"  path="/v1/projects"  auth="Bearer token"  rateLimit="60 requests / minute"  idempotency="Idempotency-Key header supported"  sdk="TypeScript | Python | Go"  since="2025-01-14">Creates a new project workspace and returns the project record with its generated identifier.</Endpoint>

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 ResponseExample
Next Schema
Ask a question... ⌘I