Fields
Set parameters for your API or SDK references
Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields.
Parameter field
The <ParamField> component is used to define parameters for your APIs or SDKs. Adding a ParamField automatically adds an API Playground.
An example of a parameter field
Properties
Whether the parameter is a query, path, body, or header. Followed by the parameter name.
Expected type of the parameter’s value.
Supports number, string, boolean, object.
Arrays can be defined using the [] suffix. For example, string[].
Indicate whether the parameter is required.
Indicate whether the parameter is deprecated.
Default value used by the server if the request does not provide a value.
Value that will be used to initialize the playground.
Placeholder text for the input in the playground.
Description of the parameter (Markdown-enabled).
Response field
The <ResponseField> component defines the return values of an API.
An example of a response field
Properties
The name of the response value.
Expected type of the response value. This can be any arbitrary string.
The default value.
Indicate whether the response is required.
Whether a field is deprecated.
Labels that are shown before the name of the field.
Labels that are shown after the name of the field.