Fields

Configure parameters for your API or SDK documentation.

Fields allow you to describe both the inputs (parameters) and outputs (responses) of your API. The main field component is available: Field for parameters and for responses.

Fields Usage

Use the <Field> component to declare API or SDK parameters, or define the return values of an API.

paramstringrequired

Example definition of a parameter field.

<Field value="param" type="string" required>
  Example definition of a parameter field.
</Field>

Properties

valuestringrequired

The name of the field.

typestringrequired

The type of the field.

requiredboolean

Whether the field is required.