Ariadocs

OpenAPI.Parameter

Edit on GitHub

Parameters, grouped by where they're sent.

Preview

Query Parameters

limitinteger

Number of items to return.

Range: >= 1, <= 100
afterstring

Return items after this cursor.

beforestring

Return items before this cursor.

OpenAPI.Operation.Parameters groups parameters into path, query, header and cookie sections. Each row shows the name, type, whether it's required, the description, the allowed values and an example if the spec has one.

To render one parameter:

<OpenAPI.Parameter parameter={operation.parameters[0]} />

Or choose its parts:

<OpenAPI.Parameter parameter={parameter}>
  <OpenAPI.Parameter.Name />
  <OpenAPI.Parameter.Required />
  <OpenAPI.Parameter.Description />
</OpenAPI.Parameter>

The parts are Header, Name, In, Required, Description, Details, Schema and Example.