Response fields

Document API response fields using the ResponseField component with type annotations, descriptions, and required or optional indicators.

Use the <ResponseField> component to define the return values of an API. Many docs also use <ResponseField> on pages when you need to list the types of something.

• response (string, required) — A response field example

<ResponseField name="response" type="string" required>
  A response field example
</ResponseField>

• name (string, required) — The name of the response value.

• type (string, required) — Expected type of the response value. This can be any arbitrary string.

• default (string) — The default value.

• required (boolean) — Show "required" beside the field name.

• deprecated (boolean) — Whether you have deprecated a field or not.

• pre (string[]) — Labels that appear before the name of the field.

• post (string[]) — Labels that appear after the name of the field.

<ResponseField name="response" type="string" required>
  A response field example
</ResponseField>

• Fields
• Expandables
• Create manual API pages