Skip to main content
There are two types of fields: Parameter Fields and Response Fields.

​
Parameter Field

A ParamField component is used to define the parameters for your APIs or SDKs. Adding a ParamField will automatically add an API Playground.
​
string
required
An example of a parameter field

​
Props

​
string
Whether it is a query, path, body, or header parameter followed by the name
​
string
Expected type of the parameter’s valueSupports number, string, bool, object.Arrays can be defined using the [] suffix. For example string[].
​
boolean
Indicate whether the parameter is required
​
boolean
Indicate whether the parameter is deprecated
​
string
Default value used by the server if the request does not provide a value
​
any
Value that will be used to initialize the playground
​
string
Placeholder text for the input in the playground
​
string
Description of the parameter (markdown enabled)

​
Response Field

The <ResponseField> component is designed to define the return values of an API. Many docs also use <ResponseField> on pages when you need to list the types of something.
​
string
required
A response field example

​
Props

​
string
required
The name of the response value.
​
string
required
Expected type of the response value - this can be any arbitrary string.
​
string
The default value.
​
boolean
Show “required” beside the field name.
​
boolean
Whether a field is deprecated or not.
​
string[]
Labels that are shown before the name of the field
​
string[]
Labels that are shown after the name of the field