Components

Response Field

Reference for documenting API response fields with types, requirements, and status indicators.

Basic syntax

Use the <ResponseField> component to document API response fields with their type and status.

ResponseField is similar to ParamField but specifically designed for documenting API response fields and returned data structures.

<ResponseField name="id" field-type="string" required="true">
  Unique identifier for the resource.
</ResponseField>

idstring

Required

Unique identifier for the resource.

<ResponseField name="description" field-type="string">
  Optional description text for the resource.
</ResponseField>

descriptionstring

Optional description text for the resource.

<ResponseField name="legacy_id" field-type="integer" deprecated="true">
  Deprecated legacy identifier. Use `id` instead.
</ResponseField>

legacy_idinteger

Deprecated

Deprecated legacy identifier. Use id instead.

<ResponseField name="user" field-type="object" required="true">
  User object containing profile information and preferences.
</ResponseField>

userobject

Required

User object containing profile information and preferences.

Field name displayed in the response documentation (default: "response").

Data type: string, integer, boolean, object, array, etc.

Set to "true" for required fields (default: "false").

Set to "true" to mark as deprecated (default: "false").

Was this page helpful?

Last updated 1 week ago