1. API Components
  2. Parameter Types

All ParamField components are added as interactive elements in the API playground. See the demo for an example.

user_id
string

The id of the user

filterRequired
string

The filtering command used to sort through the users

user_ageDefault: 0
integer

The age of the user. Cannot be less than 0

<ParamField path="user_id" type="string">
  The id of the user
</ParamField>

Props

NameTypeDescription
query, path, body, headerstringWhether it is a query, path, body, or header parameter followed by the name
typestringExpected type of the parameter’s value
requiredbooleanIndicate whether the parameter is required
optionalbooleanIndicate whether the parameter is optional
defaultstringDefault value
placeholderstringPlaceholder value for the input in the playground
childrenstringDescription of the parameter (markdown enabled)