Properties

PropDefaultType

query, path

-

string

Whether the parameter is a query, path, body, or header. Followed by the parameter name.

limit

10

integer

The maximum number of items to return in the response. Defaults to 10 if not specified.

includeMetadata

-

boolean

Whether to include additional metadata in the response. When true, extra fields like timestamps and validation status are included.

sortOrder

-

array

An array of sort criteria objects. Each object should contain a 'field' and 'direction' property.

behavior

append

enum

The behavior of the parameter

Parameter Field | Chakra UI Pro