Fields

Document request parameters and response fields

Use one of query, path, body, or header as the name of a request parameter.

​

Usage

<ParamField query="limit" type="number" default="20">
  Maximum results to return.
</ParamField>

<ResponseField name="items" type="object[]" required>
  The returned items.
</ResponseField>

Both components accept type, required, deprecated, and default.

​

Example

limit · number · default: "20"

Maximum results to return.

items · object[] · required

The returned items.