Attribute Reference

This page is generated automatically from the swagger-php sources.

For improvements head over to GitHub and create a PR ;)

In addition to this page, there are also a number of examples which might help you out.

Attributes

AdditionalProperties

Allowed in

<a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#additionalproperties">AdditionalProperties</a>

Nested elements

<a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object|null</span></dt> <dd><p>The relative or absolute path to the endpoint.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="https://spec.openapis.org/oas/v3.1.1.html#reference-object">Reference Object</a></td></tr></tbody></table></dd> <dt><strong>schema</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The key into Components->schemas array.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>title</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.

Preferably short; use <code>description</code> for more details.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>maxProperties</strong> : <span style="font-family: monospace;">int|null</span></dt> <dd><p>The maximum number of properties allowed in an object instance.

An object instance is valid against this property if its number of properties is less than, or equal to, the

value of this attribute.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>minProperties</strong> : <span style="font-family: monospace;">int|null</span></dt> <dd><p>The minimum number of properties allowed in an object instance.

An object instance is valid against this property if its number of properties is greater than, or equal to, the

value of this attribute.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>required</strong> : <span style="font-family: monospace;">string[]</span></dt> <dd><p>An object instance is valid against this property if its property set contains all elements in this property's

array value.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>properties</strong> : <span style="font-family: monospace;">Property[]</span></dt> <dd><p>A collection of properties to define for an object.

Each property is represented as an instance of the <a href="#property">Property</a> class.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>type</strong> : <span style="font-family: monospace;">string|non-empty-array<string>|null</span></dt> <dd><p>The type of the schema/property.

OpenApi v3.0: The value MUST be one of "string", "number", "integer", "boolean", "array" or "object".

Since OpenApi v3.1 an array of types may be used.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>format</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The extending format for the previously mentioned type.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="https://spec.openapis.org/oas/v3.1.1.html#data-types">Data Types</a></td></tr></tbody></table></dd> <dt><strong>items</strong> : <span style="font-family: monospace;">OpenApi\Attributes\Items|null</span></dt> <dd><p>Required if type is "array". Describes the type of items in the array.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>collectionFormat</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>Determines the format of the array if type array is used.

Possible values are:

csv: comma separated values foo,bar.
ssv: space separated values foo bar.
tsv: tab separated values foo\tbar.
pipes: pipe separated values foo|bar.
multi: corresponds to multiple parameter instances instead of multiple values for a single instance

foo=bar&foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default

value is csv.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>default</strong> : <span style="font-family: monospace;">mixed|null</span></dt> <dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></td></tr></tbody></table></dd> <dt><strong>maximum</strong> : <span style="font-family: monospace;">int|float</span></dt> <dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></td></tr></tbody></table></dd> <dt><strong>exclusiveMaximum</strong> : <span style="font-family: monospace;">int|float|bool|null</span></dt> <dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.

When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>minimum</strong> : <span style="font-family: monospace;">int|float</span></dt> <dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></td></tr></tbody></table></dd> <dt><strong>exclusiveMinimum</strong> : <span style="font-family: monospace;">int|float|bool|null</span></dt> <dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.

When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>maxLength</strong> : <span style="font-family: monospace;">int|null</span></dt> <dd><p>The maximum length of a string property.

A string instance is valid against this property if its length is less than, or equal to, the value of this

attribute.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>minLength</strong> : <span style="font-family: monospace;">int|null</span></dt> <dd><p>The minimum length of a string property.

A string instance is valid against this property if its length is greater than, or equal to, the value of this

attribute.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>maxItems</strong> : <span style="font-family: monospace;">int|null</span></dt> <dd><p>The maximum number of items allowed in an array property.

An array instance is valid against this property if its number of items is less than, or equal to, the value of

this attribute.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>minItems</strong> : <span style="font-family: monospace;">int|null</span></dt> <dd><p>The minimum number of items allowed in an array property.

An array instance is valid against this property if its number of items is greater than, or equal to, the value

of this attribute.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>uniqueItems</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>A boolean value indicating whether all items in an array property must be unique.

If this attribute is set to true, then all items in the array must be unique.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>pattern</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>enum</strong> : <span style="font-family: monospace;">array<string|int|float|bool|\UnitEnum|null>|class-string|null</span></dt> <dd><p>A collection of allowable values for a property.

A property instance is valid against this attribute if its value is one of the values specified in this

collection.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></td></tr></tbody></table></dd>

<dt><strong>discriminator</strong> : <span style="font-family: monospace;">OpenApi\Attributes\Discriminator|null</span></dt> <dd><p>Adds support for polymorphism.

The discriminator is an object name that is used to differentiate between other schemas which may satisfy the

payload description. See Composition and Inheritance for more details.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>readOnly</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Declares the property as "read only".

Relevant only for Schema "properties" definitions.

This means that it may be sent as part of a response but should not be sent as part of the request.

If the property is marked as readOnly being true and is in the required list, the required will take effect on

the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is

false.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>writeOnly</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Declares the property as "write only".

Relevant only for Schema "properties" definitions.

Therefore, it may be sent as part of a request but should not be sent as part of the response.

If the property is marked as writeOnly being true and is in the required list, the required will take effect on

the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is

false.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>xml</strong> : <span style="font-family: monospace;">OpenApi\Attributes\Xml|null</span></dt> <dd><p>This may be used only on properties schemas.

It has no effect on root schemas.

Adds additional metadata to describe the XML representation of this property.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to

contain the example with escaping where necessary.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>nullable</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Allows sending a null value for the defined schema.

Default value is false.

This must not be used when using OpenApi version 3.1,

instead make the "type" property an array and add "null" as a possible type.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.

Default value is false.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>allOf</strong> : <span style="font-family: monospace;">array<Schema|OA\Schema></span></dt> <dd><p>An instance validates successfully against this property if it validates successfully against all schemas

defined by this property's value.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>anyOf</strong> : <span style="font-family: monospace;">array<Schema|OA\Schema></span></dt> <dd><p>An instance validates successfully against this property if it validates successfully against at least one

schema defined by this property's value.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>oneOf</strong> : <span style="font-family: monospace;">array<Schema|OA\Schema></span></dt> <dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema

defined by this property's value.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

The keys inside the array will be prefixed with <code>x-</code>.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Attachable

Allowed in

<a href="#additionalproperties">AdditionalProperties</a>, <a href="#components">Components</a>, <a href="#contact">Contact</a>, <a href="#delete">Delete</a>, <a href="#discriminator">Discriminator</a>, <a href="#encoding">Encoding</a>, <a href="#examples">Examples</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#flow">Flow</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#header">Header</a>, <a href="#info">Info</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#license">License</a>, <a href="#link">Link</a>, <a href="#mediatype">MediaType</a>, <a href="#openapi">OpenApi</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#patch">Patch</a>, <a href="#pathitem">PathItem</a>, <a href="#pathparameter">PathParameter</a>, <a href="#post">Post</a>, <a href="#property">Property</a>, <a href="#put">Put</a>, <a href="#requestbody">RequestBody</a>, <a href="#response">Response</a>, <a href="#schema">Schema</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#server">Server</a>, <a href="#servervariable">ServerVariable</a>, <a href="#tag">Tag</a>, <a href="#trace">Trace</a>, <a href="#webhook">Webhook</a>, <a href="#xml">Xml</a>, <a href="#xmlcontent">XmlContent</a>

Parameters

<dl> <dt><strong>properties</strong> : <span style="font-family: monospace;">array</span></dt> <dd><p>No details available.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> </dl>

Components

Allowed in

<a href="#openapi">OpenApi</a>

Nested elements

<a href="#response">Response</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#requestbody">RequestBody</a>, <a href="#examples">Examples</a>, <a href="#header">Header</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#link">Link</a>, <a href="#schema">Schema</a>, <a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>schemas</strong> : <span style="font-family: monospace;">array<Schema|OA\Schema>|null</span></dt> <dd><p>Reusable Schemas.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>responses</strong> : <span style="font-family: monospace;">Response[]|null</span></dt> <dd><p>Reusable Responses.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>parameters</strong> : <span style="font-family: monospace;">Parameter[]|null</span></dt> <dd><p>Reusable Parameters.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>requestBodies</strong> : <span style="font-family: monospace;">RequestBody[]|null</span></dt> <dd><p>Reusable Request Bodies.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>examples</strong> : <span style="font-family: monospace;">array<Examples>|null</span></dt> <dd><p>Reusable Examples.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>headers</strong> : <span style="font-family: monospace;">Header[]|null</span></dt> <dd><p>Reusable Headers.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>securitySchemes</strong> : <span style="font-family: monospace;">SecurityScheme[]|null</span></dt> <dd><p>Reusable Security Schemes.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>links</strong> : <span style="font-family: monospace;">Link[]|null</span></dt> <dd><p>Reusable Links.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>callbacks</strong> : <span style="font-family: monospace;">array|null</span></dt> <dd><p>Reusable Callbacks.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>x</strong> : <span style="font-family: monospace;">array<string,mixed>|null</span></dt> <dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Contact

Allowed in

Nested elements

<a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>name</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The identifying name of the contact person/organization.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>url</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The URL pointing to the contact information.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>email</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The email address of the contact person/organization.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>x</strong> : <span style="font-family: monospace;">array<string,mixed>|null</span></dt> <dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

CookieParameter

Allowed in

<a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>

Nested elements

<a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>parameter</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>name</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The (case-sensitive) name of the parameter.

If in is "path", the name field must correspond to the associated path segment from the path field in the Paths Object.

If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition shall be ignored.

For all other cases, the name corresponds to the parameter name used by the in property.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd>

<dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>A brief description of the parameter.

This could contain examples of use.

CommonMark syntax may be used for rich text representation.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>in</strong> : <span style="font-family: monospace;">'query'|'header'|'path'|'cookie'|null</span></dt> <dd><p>This takes 'cookie' as the default location.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd> <dt><strong>required</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Determines whether this parameter is mandatory.

If the parameter location is "path", this property is required and its value must be true.

Otherwise, the property may be included and its default value is false.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>allowEmptyValue</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Sets the ability to pass empty-valued parameters.

This is valid only for query parameters and allows sending a parameter with an empty value.

Default value is false.

If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object|null</span></dt> <dd><p>The relative or absolute path to the endpoint.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="https://spec.openapis.org/oas/v3.1.1.html#reference-object">Reference Object</a></td></tr></tbody></table></dd> <dt><strong>schema</strong> : <span style="font-family: monospace;">OpenApi\Attributes\Schema|null</span></dt> <dd><p>The schema defining the type used for the parameter.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>example</strong> : <span style="font-family: monospace;">mixed|null</span></dt> <dd><p>Example of the media type.

The example should match the specified schema and encoding properties if present.

The example object is mutually exclusive of the examples object.

Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.

To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>examples</strong> : <span style="font-family: monospace;">array<Examples></span></dt> <dd><p>Examples of the parameter.

Each example should contain a value in the correct format as specified in the parameter encoding.

The examples object is mutually exclusive of the example object.

Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>content</strong> : <span style="font-family: monospace;">array<MediaType>|JsonContent|XmlContent|Attachable|null</span></dt> <dd><p>A map containing the representations for the parameter.

The key is the media type and the value describes it.

The map must only contain one entry.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>style</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.

Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>explode</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.

For other types of parameters this property has no effect.

When style is form, the default value is true.

For all other styles, the default value is false.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>allowReserved</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding.

This property only applies to parameters with an in value of query.

The default value is false.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>spaceDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt> <dd><p>Space separated array values.

This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>pipeDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt> <dd><p>Pipe separated array values.

This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>x</strong> : <span style="font-family: monospace;">array<string,mixed>|null</span></dt> <dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Delete

Allowed in

<a href="#pathitem">PathItem</a>

Nested elements

<a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>path</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>Key in the OpenApi "Paths Object" for this operation.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>operationId</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>Unique string used to identify the operation.

The id must be unique among all operations described in the API.

Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to

follow common programming naming conventions.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>A verbose explanation of the operation behavior.

CommonMark syntax MAY be used for rich text representation.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>summary</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>A short summary of what the operation does.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>security</strong> : <span style="font-family: monospace;">array|null</span></dt> <dd><p>A declaration of which security mechanisms can be used for this operation.

The list of values includes alternative security requirement objects that can be used.

Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.

To remove a top-level security declaration, an empty array can be used.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>servers</strong> : <span style="font-family: monospace;">Server[]</span></dt> <dd><p>An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by

this value.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>requestBody</strong> : <span style="font-family: monospace;">OpenApi\Attributes\RequestBody|null</span></dt> <dd><p>The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly

defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored

by consumers.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>tags</strong> : <span style="font-family: monospace;">string[]</span></dt> <dd><p>A list of tags for API documentation control.

Tags can be used for logical grouping of operations by resources or any other qualifier.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>parameters</strong> : <span style="font-family: monospace;">Parameter[]</span></dt> <dd><p>A list of parameters that are applicable for this operation.

If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.

The list must not include duplicated parameters.

A unique parameter is defined by a combination of a name and location.

The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's

components/parameters.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>responses</strong> : <span style="font-family: monospace;">Response[]</span></dt> <dd><p>The list of possible responses as they are returned from executing this operation.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd> <dt><strong>callbacks</strong> : <span style="font-family: monospace;">array|null</span></dt> <dd><p>A map of possible out-of band callbacks related to the parent operation.

The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider

and the expected responses. The key value used to identify the callback object is an expression, evaluated at

runtime, that identifies a URL to use for the callback operation.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

Consumers should refrain from usage of the declared operation.

Default value is false.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Discriminator

Allowed in

<a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>

Nested elements

<a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>propertyName</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The name of the property in the payload that will hold the discriminator value.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd> <dt><strong>mapping</strong> : <span style="font-family: monospace;">string[]|null</span></dt> <dd><p>An object to hold mappings between payload values and schema names or references.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>x</strong> : <span style="font-family: monospace;">array<string,mixed>|null</span></dt> <dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Encoding

Allowed in

<a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#mediatype">MediaType</a>, <a href="#property">Property</a>

Nested elements

<a href="#header">Header</a>, <a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>property</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The property name to which the encoding applies.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>contentType</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The content type.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>headers</strong> : <span style="font-family: monospace;">Header[]</span></dt> <dd><p>Additional headers.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>style</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>No details available.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>explode</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>No details available.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>allowReserved</strong> : <span style="font-family: monospace;">bool|null</span></dt> <dd><p>No details available.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>x</strong> : <span style="font-family: monospace;">array<string,mixed>|null</span></dt> <dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Examples

Allowed in

<a href="#components">Components</a>, <a href="#schema">Schema</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>

Nested elements

<a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>example</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The key into <code>#/components/examples</code>.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>summary</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>Short description for the example.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd> <dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>Embedded literal example.

The value field and externalValue field are mutually exclusive.

To represent examples of media types that cannot naturally be represented

in JSON or YAML, use a string value to contain the example, escaping where necessary.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>value</strong> : <span style="font-family: monospace;">array|string|int|null</span></dt> <dd><p>Embedded literal example.

The value field and externalValue field are mutually exclusive.

To represent examples of media types that cannot naturally be represented

<dt><strong>externalValue</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>An URL that points to the literal example.

This provides the capability to reference examples that cannot easily be included

in JSON or YAML documents.

The value field and externalValue field are mutually exclusive.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object|null</span></dt> <dd><p>The relative or absolute path to an example.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr><tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;"><a href="https://spec.openapis.org/oas/v3.1.1.html#reference-object">Reference Object</a></td></tr></tbody></table></dd> <dt><strong>x</strong> : <span style="font-family: monospace;">array<string,mixed>|null</span></dt> <dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

ExternalDocumentation

Allowed in

<a href="#openapi">OpenApi</a>, <a href="#tag">Tag</a>, <a href="#schema">Schema</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#property">Property</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>

Nested elements

<a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>A short description of the target documentation. GFM syntax can be used for rich text representation.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd> <dt><strong>url</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The URL for the target documentation.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd> <dt><strong>x</strong> : <span style="font-family: monospace;">array<string,mixed>|null</span></dt> <dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Flow

Allowed in

<a href="#securityscheme">SecurityScheme</a>

Nested elements

<a href="#attachable">Attachable</a>

Parameters

<dl> <dt><strong>authorizationUrl</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The authorization url to be used for this flow.

This must be in the form of an url.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>tokenUrl</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The token URL to be used for this flow.

This must be in the form of an url.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>refreshUrl</strong> : <span style="font-family: monospace;">string|null</span></dt> <dd><p>The URL to be used for obtaining refresh tokens.

This must be in the form of an url.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

<dt><strong>flow</strong> : <span style="font-family: monospace;">'implicit'|'password'|'authorizationCode'|'clientCredentials'|null</span></dt> <dd><p>Flow name.

One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd>

<dt><strong>scopes</strong> : <span style="font-family: monospace;">array|null</span></dt> <dd><p>The available scopes for the OAuth2 security scheme.

A map between the scope name and a short description for it.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>yes</b></td></tr></tbody></table></dd>

For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions

<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt> <dd><p>Arbitrary attachables for this annotation.

These will be ignored but can be used for custom processing.</p><table class="table-plain"><tbody><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></tbody></table></dd>

</dl>

Get