EndpointRow

Domain

Collapsible row representing a single API endpoint — shows the method badge, path, summary, and expands to an OperationPanel.

GET endpoint (expanded)

Preview

Returns a paginated list of users. Requires admin role.

UsersBearerAuth

Path

NameInTypeRequiredDescription
userId
pathstring (uuid)required
Unique identifier of the user

Query

NameInTypeRequiredDescription
page
queryintegeroptional
Page number (1-based)e.g. 1
pageSize
queryintegeroptional
Results per pagee.g. 20
roledeprecated
querystringoptional
Filter by role
admineditorviewer

Headers

NameInTypeRequiredDescription
Authorization
headerstringrequired
Bearer token
Code
<EndpointRow
  path="/users"
  operation={{ method: 'GET', summary: 'List users', ... }}
  defaultOpen
/>

Multiple endpoints

Preview
Code
<EndpointRow path="/users" operation={getOp} />
<EndpointRow path="/users" operation={postOp} />
<EndpointRow path="/users/{userId}" operation={deleteOp} />
Sourcemodules/domains/api-doc/EndpointRow.tsx