OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	08/07/2024 04:34:25 AM	rwxr-xr-x
📄 annotations.md	63.93 KB	08/07/2024 04:34:24 AM	rw-r--r--
📄 attributes.md	213.01 KB	08/07/2024 04:34:24 AM	rw-r--r--
📄 generator.md	7.07 KB	08/07/2024 04:34:24 AM	rw-r--r--
📄 index.md	854 bytes	08/07/2024 04:34:24 AM	rw-r--r--
📄 processors.md	4.13 KB	08/07/2024 04:34:25 AM	rw-r--r--

Editing: attributes.md

# Attribute Reference

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

For improvements head over to [GitHub](https://github.com/zircote/swagger-php) and create a PR ;)

In addition to this page, there are also a number of [examples](https://github.com/zircote/swagger-php/tree/master/Examples#readme) which might help you out.

## Attributes
### [AdditionalProperties](https://github.com/zircote/swagger-php/tree/master/src/Attributes/AdditionalProperties.php)

#### 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>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : string|null</dt>
 <dd>The key into Components->schemas array.</dd>
 <dt>title : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A description will provide explanation about the purpose of the instance described by this schema.</dd>
 <dt>maxProperties : int|null</dt>
 <dd>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.</dd>
 <dt>minProperties : int|null</dt>
 <dd>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.</dd>
 <dt>required : string[]</dt>
 <dd>An object instance is valid against this property if its property set contains all elements in this property's 
array value.</dd>
 <dt>properties : Property[]</dt>
 <dd>A collection of properties to define for an object. 
 
Each property is represented as an instance of the <a href="#property">Property</a> class.</dd>
 <dt>type : string|non-empty-array&lt;string&gt;|null</dt>
 <dd>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.</dd>
 <dt>format : string|null</dt>
 <dd>The extending format for the previously mentioned type. See Data Type Formats for further details.</dd>
 <dt>items : OpenApi\Attributes\Items|null</dt>
 <dd>Required if type is "array". Describes the type of items in the array.</dd>
 <dt>collectionFormat : string|null</dt>
 <dd>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.</dd>
 <dt>default : mixed|null</dt>
 <dd>Sets a default value to the parameter. The type of the value depends on the defined type.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></dd>
 <dt>maximum : int|float</dt>
 <dd>The maximum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>exclusiveMaximum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>minimum : int|float</dt>
 <dd>The minimum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>exclusiveMinimum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>maxLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></dd>
 <dt>minLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></dd>
 <dt>maxItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></dd>
 <dt>minItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></dd>
 <dt>uniqueItems : bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></dd>
 <dt>pattern : string|null</dt>
 <dd>A string instance is considered valid if the regular expression matches the instance successfully.</dd>
 <dt>enum : array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></dd>
 <dt>discriminator : OpenApi\Attributes\Discriminator|null</dt>
 <dd>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.</dd>
 <dt>readOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>writeOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>xml : OpenApi\Attributes\Xml|null</dt>
 <dd>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.</dd>
 <dt>externalDocs : OpenApi\Attributes\ExternalDocumentation|null</dt>
 <dd>Additional external documentation for this schema.</dd>
 <dt>example : mixed|null</dt>
 <dd>A free-form property to include an example of an instance for this schema. 
 
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.</dd>
 <dt>nullable : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a schema is deprecated and should be transitioned out of usage. 
Default value is false.</dd>
 <dt>allOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against all schemas 
defined by this property's value.</dd>
 <dt>anyOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against at least one 
schema defined by this property's value.</dd>
 <dt>oneOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against exactly one schema 
defined by this property's value.</dd>
 <dt>additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#anchor64.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Attachable](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Attachable.php)

#### 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="#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>properties : array</dt>
 <dd>No details available.</dd>
</dl>

### [Components](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Components.php)

#### 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>schemas : array&lt;Schema|\OpenApi\Annotations\Schema&gt;|null</dt>
 <dd>Reusable Schemas.</dd>
 <dt>responses : Response[]|null</dt>
 <dd>Reusable Responses.</dd>
 <dt>parameters : Parameter[]|null</dt>
 <dd>Reusable Parameters.</dd>
 <dt>requestBodies : RequestBody[]|null</dt>
 <dd>Reusable Request Bodies.</dd>
 <dt>examples : array&lt;Examples&gt;|null</dt>
 <dd>Reusable Examples.</dd>
 <dt>headers : Header[]|null</dt>
 <dd>Reusable Headers.</dd>
 <dt>securitySchemes : SecurityScheme[]|null</dt>
 <dd>Reusable Security Schemes.</dd>
 <dt>links : Link[]|null</dt>
 <dd>Reusable Links.</dd>
 <dt>callbacks : array|null</dt>
 <dd>Reusable Callbacks.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Contact](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Contact.php)

#### Allowed in
---
<a href="#info">Info</a>

#### Nested elements
---
<a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>name : string|null</dt>
 <dd>The identifying name of the contact person/organization.</dd>
 <dt>url : string|null</dt>
 <dd>The URL pointing to the contact information.</dd>
 <dt>email : string|null</dt>
 <dd>The email address of the contact person/organization.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [CookieParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/CookieParameter.php)

#### 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>parameter : string|null</dt>
 <dd>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</dd>
 <dt>name : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A brief description of the parameter. 
 
This could contain examples of use. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>in : string|null</dt>
 <dd>This takes 'cookie' as the default location.</dd>
 <dt>required : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a parameter is deprecated and should be transitioned out of usage.</dd>
 <dt>allowEmptyValue : bool|null</dt>
 <dd>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.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : OpenApi\Attributes\Schema|null</dt>
 <dd>The schema defining the type used for the parameter.</dd>
 <dt>example : mixed|null</dt>
 <dd>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.</dd>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>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.</dd>
 <dt>content : array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</dt>
 <dd>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.</dd>
 <dt>style : string|null</dt>
 <dd>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.</dd>
 <dt>explode : bool|null</dt>
 <dd>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.</dd>
 <dt>allowReserved : bool|null</dt>
 <dd>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.</dd>
 <dt>spaceDelimited : array|null</dt>
 <dd>Space separated array values. 
 
This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</dd>
 <dt>pipeDelimited : array|null</dt>
 <dd>Pipe separated array values. 
 
This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Delete](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Delete.php)

#### 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>path : string|null</dt>
 <dd>Key in the OpenApi "Paths Object" for this operation.</dd>
 <dt>operationId : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A verbose explanation of the operation behavior. 
 
CommonMark syntax MAY be used for rich text representation.</dd>
 <dt>summary : string|null</dt>
 <dd>A short summary of what the operation does.</dd>
 <dt>security : array|null</dt>
 <dd>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.</dd>
 <dt>servers : Server[]</dt>
 <dd>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.</dd>
 <dt>requestBody : OpenApi\Attributes\RequestBody|null</dt>
 <dd>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.</dd>
 <dt>tags : string[]</dt>
 <dd>A list of tags for API documentation control. 
 
Tags can be used for logical grouping of operations by resources or any other qualifier.</dd>
 <dt>parameters : Parameter[]</dt>
 <dd>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.</dd>
 <dt>responses : Response[]</dt>
 <dd>The list of possible responses as they are returned from executing this operation.</dd>
 <dt>callbacks : array|null</dt>
 <dd>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.</dd>
 <dt>externalDocs : OpenApi\Attributes\ExternalDocumentation|null</dt>
 <dd>Additional external documentation for this operation.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Declares this operation to be deprecated. 
 
Consumers should refrain from usage of the declared operation. 
 
Default value is false.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Discriminator](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Discriminator.php)

#### 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>propertyName : string|null</dt>
 <dd>The name of the property in the payload that will hold the discriminator value.</dd>
 <dt>mapping : string[]|null</dt>
 <dd>An object to hold mappings between payload values and schema names or references.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Examples](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Examples.php)

#### 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>example : string|null</dt>
 <dd>The key into `#/components/examples`.</dd>
 <dt>summary : string|null</dt>
 <dd>Short description for the example.</dd>
 <dt>description : string|null</dt>
 <dd>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.</dd>
 <dt>value : array|string|int|null</dt>
 <dd>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.</dd>
 <dt>externalValue : string|null</dt>
 <dd>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.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to an example.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [ExternalDocumentation](https://github.com/zircote/swagger-php/tree/master/src/Attributes/ExternalDocumentation.php)

#### 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>description : string|null</dt>
 <dd>A short description of the target documentation. GFM syntax can be used for rich text representation.</dd>
 <dt>url : string|null</dt>
 <dd>The URL for the target documentation.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Flow](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Flow.php)

#### Allowed in
---
<a href="#securityscheme">SecurityScheme</a>

#### Nested elements
---
<a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>authorizationUrl : string|null</dt>
 <dd>The authorization url to be used for this flow. 
 
This must be in the form of an url.</dd>
 <dt>tokenUrl : string|null</dt>
 <dd>The token URL to be used for this flow. 
 
This must be in the form of an url.</dd>
 <dt>refreshUrl : string|null</dt>
 <dd>The URL to be used for obtaining refresh tokens. 
 
This must be in the form of an url.</dd>
 <dt>flow : string|null</dt>
 <dd>Flow name. 
 
One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].</dd>
 <dt>scopes : array|null</dt>
 <dd>The available scopes for the OAuth2 security scheme. 
 
A map between the scope name and a short description for it.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Get](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Get.php)

#### Allowed in
---
<a href="#pathitem">PathItem</a>

### [Head](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Head.php)

#### Allowed in
---
<a href="#pathitem">PathItem</a>

### [Header](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Header.php)

#### Allowed in
---
<a href="#components">Components</a>, <a href="#response">Response</a>

#### Nested elements
---
<a href="#schema">Schema</a>, <a href="#attachable">Attachable</a>

### [HeaderParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/HeaderParameter.php)

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

#### Parameters
---
<dl>
 <dt>parameter : string|null</dt>
 <dd>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</dd>
 <dt>name : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A brief description of the parameter. 
 
This could contain examples of use. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>in : string|null</dt>
 <dd>This takes 'header' as the default location.</dd>
 <dt>required : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a parameter is deprecated and should be transitioned out of usage.</dd>
 <dt>allowEmptyValue : bool|null</dt>
 <dd>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.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : OpenApi\Attributes\Schema|null</dt>
 <dd>The schema defining the type used for the parameter.</dd>
 <dt>example : mixed|null</dt>
 <dd>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.</dd>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>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.</dd>
 <dt>content : array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</dt>
 <dd>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.</dd>
 <dt>style : string|null</dt>
 <dd>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.</dd>
 <dt>explode : bool|null</dt>
 <dd>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.</dd>
 <dt>allowReserved : bool|null</dt>
 <dd>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.</dd>
 <dt>spaceDelimited : array|null</dt>
 <dd>Space separated array values. 
 
This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</dd>
 <dt>pipeDelimited : array|null</dt>
 <dd>Pipe separated array values. 
 
This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Info](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Info.php)

#### Allowed in
---
<a href="#openapi">OpenApi</a>

#### Nested elements
---
<a href="#contact">Contact</a>, <a href="#license">License</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>version : string|null</dt>
 <dd>The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).</dd>
 <dt>description : string|null</dt>
 <dd>A short description of the application. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>title : string|null</dt>
 <dd>The title of the application.</dd>
 <dt>termsOfService : string|null</dt>
 <dd>An URL to the Terms of Service for the API. 
 
Must be in the format of an url.</dd>
 <dt>contact : OpenApi\Attributes\Contact|null</dt>
 <dd>The contact information for the exposed API.</dd>
 <dt>license : OpenApi\Attributes\License|null</dt>
 <dd>The license information for the exposed API.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Items](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Items.php)

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

### [JsonContent](https://github.com/zircote/swagger-php/tree/master/src/Attributes/JsonContent.php)

#### Nested elements
---
<a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>Examples of the schema. 
 
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.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : string|null</dt>
 <dd>The key into Components->schemas array.</dd>
 <dt>title : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A description will provide explanation about the purpose of the instance described by this schema.</dd>
 <dt>maxProperties : int|null</dt>
 <dd>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.</dd>
 <dt>minProperties : int|null</dt>
 <dd>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.</dd>
 <dt>required : string[]</dt>
 <dd>An object instance is valid against this property if its property set contains all elements in this property's 
array value.</dd>
 <dt>properties : Property[]</dt>
 <dd>A collection of properties to define for an object. 
 
Each property is represented as an instance of the <a href="#property">Property</a> class.</dd>
 <dt>type : string|non-empty-array&lt;string&gt;|null</dt>
 <dd>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.</dd>
 <dt>format : string|null</dt>
 <dd>The extending format for the previously mentioned type. See Data Type Formats for further details.</dd>
 <dt>items : OpenApi\Attributes\Items|null</dt>
 <dd>Required if type is "array". Describes the type of items in the array.</dd>
 <dt>collectionFormat : string|null</dt>
 <dd>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.</dd>
 <dt>default : mixed|null</dt>
 <dd>Sets a default value to the parameter. The type of the value depends on the defined type.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></dd>
 <dt>maximum : int|float</dt>
 <dd>The maximum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>exclusiveMaximum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>minimum : int|float</dt>
 <dd>The minimum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>exclusiveMinimum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>maxLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></dd>
 <dt>minLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></dd>
 <dt>maxItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></dd>
 <dt>minItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></dd>
 <dt>uniqueItems : bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></dd>
 <dt>pattern : string|null</dt>
 <dd>A string instance is considered valid if the regular expression matches the instance successfully.</dd>
 <dt>enum : array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></dd>
 <dt>discriminator : OpenApi\Attributes\Discriminator|null</dt>
 <dd>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.</dd>
 <dt>readOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>writeOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>xml : OpenApi\Attributes\Xml|null</dt>
 <dd>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.</dd>
 <dt>externalDocs : OpenApi\Attributes\ExternalDocumentation|null</dt>
 <dd>Additional external documentation for this schema.</dd>
 <dt>example : mixed|null</dt>
 <dd>A free-form property to include an example of an instance for this schema. 
 
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.</dd>
 <dt>nullable : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a schema is deprecated and should be transitioned out of usage. 
Default value is false.</dd>
 <dt>allOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against all schemas 
defined by this property's value.</dd>
 <dt>anyOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against at least one 
schema defined by this property's value.</dd>
 <dt>oneOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against exactly one schema 
defined by this property's value.</dd>
 <dt>additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#anchor64.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [License](https://github.com/zircote/swagger-php/tree/master/src/Attributes/License.php)

#### Allowed in
---
<a href="#info">Info</a>

#### Nested elements
---
<a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>name : string|null</dt>
 <dd>The license name used for the API.</dd>
 <dt>identifier : string|null</dt>
 <dd>An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.</dd>
 <dt>url : string|null</dt>
 <dd>An URL to the license used for the API. This MUST be in the form of a URL. 
 
The `url` field is mutually exclusive of the `identifier` field.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Link](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Link.php)

#### Allowed in
---
<a href="#components">Components</a>, <a href="#response">Response</a>

#### Nested elements
---
<a href="#server">Server</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>link : string|null</dt>
 <dd>The key into MediaType->links array.</dd>
 <dt>operationRef : string|null</dt>
 <dd>A relative or absolute reference to an OA operation. 
 
This field is mutually exclusive of the <code>operationId</code> field, and must point to an Operation object. 
 
Relative values may be used to locate an existing Operation object in the OpenAPI definition.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>No details available.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>operationId : string|null</dt>
 <dd>The name of an existing, resolvable OA operation, as defined with a unique <code>operationId</code>. 
 
This field is mutually exclusive of the <code>operationRef</code> field.</dd>
 <dt>parameters : array&lt;string,mixed&gt;</dt>
 <dd>A map representing parameters to pass to an operation as specified with operationId or identified via 
operationRef. 
 
The key is the parameter name to be used, whereas the value can be a constant or an expression to 
be evaluated and passed to the linked operation. 
The parameter name can be qualified using the parameter location [{in}.]{name} for operations 
that use the same parameter name in different locations (e.g. path.id).</dd>
 <dt>requestBody : mixed|null</dt>
 <dd>A literal value or {expression} to use as a request body when calling the target operation.</dd>
 <dt>description : string|null</dt>
 <dd>A description of the link. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>server : OpenApi\Attributes\Server|null</dt>
 <dd>A server object to be used by the target operation.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [MediaType](https://github.com/zircote/swagger-php/tree/master/src/Attributes/MediaType.php)

#### Allowed in
---
<a href="#response">Response</a>, <a href="#requestbody">RequestBody</a>

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

#### Parameters
---
<dl>
 <dt>mediaType : string|null</dt>
 <dd>The key into Operation->content array.</dd>
 <dt>schema : OpenApi\Attributes\Schema|null</dt>
 <dd>The schema defining the type used for the request body.</dd>
 <dt>example : mixed|null</dt>
 <dd>Example of the media type. 
 
The example object should be in the correct format as specified by the media type. 
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.</dd>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>Examples of the media type. 
 
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.</dd>
 <dt>encoding : array&lt;string,mixed&gt;</dt>
 <dd>A map between a property name and its encoding information. 
 
The key, being the property name, must exist in the schema as a property. 
 
The encoding object shall only apply to requestBody objects when the media type is multipart or 
application/x-www-form-urlencoded.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [OpenApi](https://github.com/zircote/swagger-php/tree/master/src/Attributes/OpenApi.php)

#### Nested elements
---
<a href="#info">Info</a>, <a href="#server">Server</a>, <a href="#pathitem">PathItem</a>, <a href="#components">Components</a>, <a href="#tag">Tag</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#webhook">Webhook</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>openapi : string</dt>
 <dd>The semantic version number of the OpenAPI Specification version that the OpenAPI document uses. 
 
The openapi field should be used by tooling specifications and clients to interpret the OpenAPI document. 
 
A version specified via `Generator::setVersion()` will overwrite this value. 
 
This is not related to the API info::version string.</dd>
 <dt>info : OpenApi\Attributes\Info|null</dt>
 <dd>Provides metadata about the API. The metadata may be used by tooling as required.</dd>
 <dt>servers : Server[]|null</dt>
 <dd>An array of <code>@Server</code> objects, which provide connectivity information to a target server. 
 
If not provided, or is an empty array, the default value would be a Server Object with an url value of <code>/</code>.</dd>
 <dt>security : array|null</dt>
 <dd>A declaration of which security mechanisms can be used across the API. 
 
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. 
Individual operations can override this definition. 
To make security optional, an empty security requirement `({})` can be included in the array.</dd>
 <dt>tags : Tag[]|null</dt>
 <dd>A list of tags used by the specification with additional metadata. 
 
The order of the tags can be used to reflect on their order by the parsing tools. 
Not all tags that are used by the Operation Object must be declared. 
The tags that are not declared may be organized randomly or based on the tools' logic. 
Each tag name in the list must be unique.</dd>
 <dt>externalDocs : OpenApi\Attributes\ExternalDocumentation|null</dt>
 <dd>Additional external documentation.</dd>
 <dt>paths : PathItem[]|null</dt>
 <dd>The available paths and operations for the API.</dd>
 <dt>components : OpenApi\Attributes\Components|null</dt>
 <dd>An element to hold various components for the specification.</dd>
 <dt>webhooks : Webhook[]|null</dt>
 <dd>The available webhooks for the API.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Options](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Options.php)

#### Allowed in
---
<a href="#pathitem">PathItem</a>

### [Parameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Parameter.php)

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

#### Parameters
---
<dl>
 <dt>parameter : string|null</dt>
 <dd>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</dd>
 <dt>name : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A brief description of the parameter. 
 
This could contain examples of use. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>in : string|null</dt>
 <dd>The location of the parameter. 
 
Possible values are "query", "header", "path" or "cookie".</dd>
 <dt>required : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a parameter is deprecated and should be transitioned out of usage.</dd>
 <dt>allowEmptyValue : bool|null</dt>
 <dd>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.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : OpenApi\Attributes\Schema|null</dt>
 <dd>The schema defining the type used for the parameter.</dd>
 <dt>example : mixed|null</dt>
 <dd>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.</dd>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>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.</dd>
 <dt>content : array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</dt>
 <dd>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.</dd>
 <dt>style : string|null</dt>
 <dd>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.</dd>
 <dt>explode : bool|null</dt>
 <dd>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.</dd>
 <dt>allowReserved : bool|null</dt>
 <dd>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.</dd>
 <dt>spaceDelimited : array|null</dt>
 <dd>Space separated array values. 
 
This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</dd>
 <dt>pipeDelimited : array|null</dt>
 <dd>Pipe separated array values. 
 
This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Patch](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Patch.php)

#### Allowed in
---
<a href="#pathitem">PathItem</a>

### [PathItem](https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathItem.php)

#### Allowed in
---
<a href="#openapi">OpenApi</a>

#### Nested elements
---
<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="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>path : string|null</dt>
 <dd>Key for the Path Object (OpenApi->paths array).</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>No details available.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>summary : string|null</dt>
 <dd>An optional, string summary, intended to apply to all operations in this path.</dd>
 <dt>description : string|null</dt>
 <dd>An optional, string description, intended to apply to all operations in this path.</dd>
 <dt>get : OpenApi\Attributes\Get|null</dt>
 <dd>A definition of a GET operation on this path.</dd>
 <dt>put : OpenApi\Attributes\Put|null</dt>
 <dd>A definition of a PUT operation on this path.</dd>
 <dt>post : OpenApi\Attributes\Post|null</dt>
 <dd>A definition of a POST operation on this path.</dd>
 <dt>delete : OpenApi\Attributes\Delete|null</dt>
 <dd>A definition of a DELETE operation on this path.</dd>
 <dt>options : OpenApi\Attributes\Options|null</dt>
 <dd>A definition of a OPTIONS operation on this path.</dd>
 <dt>head : OpenApi\Attributes\Head|null</dt>
 <dd>A definition of a HEAD operation on this path.</dd>
 <dt>patch : OpenApi\Attributes\Patch|null</dt>
 <dd>A definition of a PATCH operation on this path.</dd>
 <dt>trace : OpenApi\Attributes\Trace|null</dt>
 <dd>A definition of a TRACE operation on this path.</dd>
 <dt>servers : Server[]|null</dt>
 <dd>An alternative server array to service all operations in this path.</dd>
 <dt>parameters : Parameter[]|null</dt>
 <dd>A list of parameters that are applicable for all the operations described under this path. 
 
These parameters can be overridden at the operation level, but cannot be removed there. 
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.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [PathParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathParameter.php)

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

#### Parameters
---
<dl>
 <dt>parameter : string|null</dt>
 <dd>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</dd>
 <dt>name : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A brief description of the parameter. 
 
This could contain examples of use. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>in : string|null</dt>
 <dd>This takes 'path' as the default location.</dd>
 <dt>required : bool|null</dt>
 <dd>No details available.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a parameter is deprecated and should be transitioned out of usage.</dd>
 <dt>allowEmptyValue : bool|null</dt>
 <dd>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.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : OpenApi\Attributes\Schema|null</dt>
 <dd>The schema defining the type used for the parameter.</dd>
 <dt>example : mixed|null</dt>
 <dd>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.</dd>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>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.</dd>
 <dt>content : array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</dt>
 <dd>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.</dd>
 <dt>style : string|null</dt>
 <dd>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.</dd>
 <dt>explode : bool|null</dt>
 <dd>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.</dd>
 <dt>allowReserved : bool|null</dt>
 <dd>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.</dd>
 <dt>spaceDelimited : array|null</dt>
 <dd>Space separated array values. 
 
This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</dd>
 <dt>pipeDelimited : array|null</dt>
 <dd>Pipe separated array values. 
 
This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Post](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Post.php)

#### Allowed in
---
<a href="#pathitem">PathItem</a>

### [Property](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Property.php)

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

#### Parameters
---
<dl>
 <dt>property : string|null</dt>
 <dd>The key into Schema->properties array.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : string|null</dt>
 <dd>The key into Components->schemas array.</dd>
 <dt>title : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A description will provide explanation about the purpose of the instance described by this schema.</dd>
 <dt>maxProperties : int|null</dt>
 <dd>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.</dd>
 <dt>minProperties : int|null</dt>
 <dd>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.</dd>
 <dt>required : string[]</dt>
 <dd>An object instance is valid against this property if its property set contains all elements in this property's 
array value.</dd>
 <dt>properties : Property[]</dt>
 <dd>A collection of properties to define for an object. 
 
Each property is represented as an instance of the <a href="#property">Property</a> class.</dd>
 <dt>type : string|non-empty-array&lt;string&gt;|null</dt>
 <dd>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.</dd>
 <dt>format : string|null</dt>
 <dd>The extending format for the previously mentioned type. See Data Type Formats for further details.</dd>
 <dt>items : OpenApi\Attributes\Items|null</dt>
 <dd>Required if type is "array". Describes the type of items in the array.</dd>
 <dt>collectionFormat : string|null</dt>
 <dd>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.</dd>
 <dt>default : mixed|null</dt>
 <dd>Sets a default value to the parameter. The type of the value depends on the defined type.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></dd>
 <dt>maximum : int|float</dt>
 <dd>The maximum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>exclusiveMaximum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>minimum : int|float</dt>
 <dd>The minimum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>exclusiveMinimum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>maxLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></dd>
 <dt>minLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></dd>
 <dt>maxItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></dd>
 <dt>minItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></dd>
 <dt>uniqueItems : bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></dd>
 <dt>pattern : string|null</dt>
 <dd>A string instance is considered valid if the regular expression matches the instance successfully.</dd>
 <dt>enum : array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></dd>
 <dt>discriminator : OpenApi\Attributes\Discriminator|null</dt>
 <dd>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.</dd>
 <dt>readOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>writeOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>xml : OpenApi\Attributes\Xml|null</dt>
 <dd>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.</dd>
 <dt>externalDocs : OpenApi\Attributes\ExternalDocumentation|null</dt>
 <dd>Additional external documentation for this schema.</dd>
 <dt>example : mixed|null</dt>
 <dd>A free-form property to include an example of an instance for this schema. 
 
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.</dd>
 <dt>nullable : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a schema is deprecated and should be transitioned out of usage. 
Default value is false.</dd>
 <dt>allOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against all schemas 
defined by this property's value.</dd>
 <dt>anyOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against at least one 
schema defined by this property's value.</dd>
 <dt>oneOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against exactly one schema 
defined by this property's value.</dd>
 <dt>additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#anchor64.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Put](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Put.php)

#### Allowed in
---
<a href="#pathitem">PathItem</a>

### [QueryParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/QueryParameter.php)

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

#### Parameters
---
<dl>
 <dt>parameter : string|null</dt>
 <dd>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</dd>
 <dt>name : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A brief description of the parameter. 
 
This could contain examples of use. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>in : string|null</dt>
 <dd>This takes 'query' as the default location.</dd>
 <dt>required : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a parameter is deprecated and should be transitioned out of usage.</dd>
 <dt>allowEmptyValue : bool|null</dt>
 <dd>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.</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : OpenApi\Attributes\Schema|null</dt>
 <dd>The schema defining the type used for the parameter.</dd>
 <dt>example : mixed|null</dt>
 <dd>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.</dd>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>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.</dd>
 <dt>content : array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</dt>
 <dd>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.</dd>
 <dt>style : string|null</dt>
 <dd>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.</dd>
 <dt>explode : bool|null</dt>
 <dd>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.</dd>
 <dt>allowReserved : bool|null</dt>
 <dd>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.</dd>
 <dt>spaceDelimited : array|null</dt>
 <dd>Space separated array values. 
 
This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</dd>
 <dt>pipeDelimited : array|null</dt>
 <dd>Pipe separated array values. 
 
This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [RequestBody](https://github.com/zircote/swagger-php/tree/master/src/Attributes/RequestBody.php)

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

#### Nested elements
---
<a href="#mediatype">MediaType</a>, <a href="#attachable">Attachable</a>

### [Response](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Response.php)

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

#### Nested elements
---
<a href="#mediatype">MediaType</a>, <a href="#header">Header</a>, <a href="#link">Link</a>, <a href="#attachable">Attachable</a>

### [Schema](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Schema.php)

#### Allowed in
---
<a href="#components">Components</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#header">Header</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="#examples">Examples</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>ref : string|class-string|object|null</dt>
 <dd>The relative or absolute path to the endpoint.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>schema : string|null</dt>
 <dd>The key into Components->schemas array.</dd>
 <dt>title : string|null</dt>
 <dd>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.</dd>
 <dt>description : string|null</dt>
 <dd>A description will provide explanation about the purpose of the instance described by this schema.</dd>
 <dt>maxProperties : int|null</dt>
 <dd>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.</dd>
 <dt>minProperties : int|null</dt>
 <dd>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.</dd>
 <dt>required : string[]</dt>
 <dd>An object instance is valid against this property if its property set contains all elements in this property's 
array value.</dd>
 <dt>properties : Property[]</dt>
 <dd>A collection of properties to define for an object. 
 
Each property is represented as an instance of the <a href="#property">Property</a> class.</dd>
 <dt>type : string|non-empty-array&lt;string&gt;|null</dt>
 <dd>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.</dd>
 <dt>format : string|null</dt>
 <dd>The extending format for the previously mentioned type. See Data Type Formats for further details.</dd>
 <dt>items : OpenApi\Attributes\Items|null</dt>
 <dd>Required if type is "array". Describes the type of items in the array.</dd>
 <dt>collectionFormat : string|null</dt>
 <dd>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.</dd>
 <dt>default : mixed|null</dt>
 <dd>Sets a default value to the parameter. The type of the value depends on the defined type.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></dd>
 <dt>maximum : int|float</dt>
 <dd>The maximum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>exclusiveMaximum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></dd>
 <dt>minimum : int|float</dt>
 <dd>The minimum value allowed for a numeric property. This value must be a number.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>exclusiveMinimum : int|float|bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></dd>
 <dt>maxLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></dd>
 <dt>minLength : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></dd>
 <dt>maxItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></dd>
 <dt>minItems : int|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></dd>
 <dt>uniqueItems : bool|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></dd>
 <dt>pattern : string|null</dt>
 <dd>A string instance is considered valid if the regular expression matches the instance successfully.</dd>
 <dt>enum : array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</dt>
 <dd>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.See: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></dd>
 <dt>discriminator : OpenApi\Attributes\Discriminator|null</dt>
 <dd>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.</dd>
 <dt>readOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>writeOnly : bool|null</dt>
 <dd>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.</dd>
 <dt>xml : OpenApi\Attributes\Xml|null</dt>
 <dd>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.</dd>
 <dt>externalDocs : OpenApi\Attributes\ExternalDocumentation|null</dt>
 <dd>Additional external documentation for this schema.</dd>
 <dt>example : mixed|null</dt>
 <dd>A free-form property to include an example of an instance for this schema. 
 
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.</dd>
 <dt>examples : array&lt;Examples&gt;</dt>
 <dd>Examples of the schema. 
 
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.</dd>
 <dt>nullable : bool|null</dt>
 <dd>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.</dd>
 <dt>deprecated : bool|null</dt>
 <dd>Specifies that a schema is deprecated and should be transitioned out of usage. 
Default value is false.</dd>
 <dt>allOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against all schemas 
defined by this property's value.</dd>
 <dt>anyOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against at least one 
schema defined by this property's value.</dd>
 <dt>oneOf : array&lt;Schema|\OpenApi\Annotations\Schema&gt;</dt>
 <dd>An instance validates successfully against this property if it validates successfully against exactly one schema 
defined by this property's value.</dd>
 <dt>additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#anchor64.</dd>
 <dt>const : mixed|null</dt>
 <dd>http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [SecurityScheme](https://github.com/zircote/swagger-php/tree/master/src/Attributes/SecurityScheme.php)

#### Allowed in
---
<a href="#components">Components</a>

#### Nested elements
---
<a href="#flow">Flow</a>, <a href="#attachable">Attachable</a>

### [Server](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Server.php)

#### Allowed in
---
<a href="#openapi">OpenApi</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>, <a href="#link">Link</a>

#### Nested elements
---
<a href="#servervariable">ServerVariable</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>url : string|null</dt>
 <dd>An URL to the target host. 
 
This URL supports Server Variables and may be relative, 
to indicate that the host location is relative to the location where the OpenAPI document is being served. 
Variable substitutions will be made when a variable is named in {brackets}.</dd>
 <dt>description : string|null</dt>
 <dd>An optional string describing the host designated by the URL. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>variables : ServerVariable[]</dt>
 <dd>A map between a variable name and its value. 
 
The value is used for substitution in the server's URL template.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [ServerVariable](https://github.com/zircote/swagger-php/tree/master/src/Attributes/ServerVariable.php)

#### Allowed in
---
<a href="#server">Server</a>

#### Nested elements
---
<a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>serverVariable : string|null</dt>
 <dd>The key into Server->variables array.</dd>
 <dt>description : string|null</dt>
 <dd>An optional description for the server variable. 
 
CommonMark syntax MAY be used for rich text representation.</dd>
 <dt>default : string|null</dt>
 <dd>The default value to use for substitution, and to send, if an alternate value is not supplied. 
 
Unlike the Schema Object's default, this value must be provided by the consumer.</dd>
 <dt>enum : array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</dt>
 <dd>An enumeration of values to be used if the substitution options are from a limited set.</dd>
 <dt>variables : array|null</dt>
 <dd>A map between a variable name and its value. 
 
The value is used for substitution in the server's URL template.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Tag](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Tag.php)

#### Allowed in
---
<a href="#openapi">OpenApi</a>

#### Nested elements
---
<a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>name : string|null</dt>
 <dd>The name of the tag.</dd>
 <dt>description : string|null</dt>
 <dd>A short description for the tag. GFM syntax can be used for rich text representation.</dd>
 <dt>externalDocs : OpenApi\Attributes\ExternalDocumentation|null</dt>
 <dd>Additional external documentation for this tag.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Trace](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Trace.php)

#### Allowed in
---
<a href="#pathitem">PathItem</a>

### [Webhook](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Webhook.php)

#### Allowed in
---
<a href="#openapi">OpenApi</a>

#### Parameters
---
<dl>
 <dt>webhook : string|null</dt>
 <dd>Key for the webhooks map.</dd>
 <dt>path : string|null</dt>
 <dd>Key for the Path Object (OpenApi->paths array).</dd>
 <dt>ref : string|class-string|object|null</dt>
 <dd>No details available.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>summary : string|null</dt>
 <dd>An optional, string summary, intended to apply to all operations in this path.</dd>
 <dt>description : string|null</dt>
 <dd>An optional, string description, intended to apply to all operations in this path.</dd>
 <dt>get : OpenApi\Attributes\Get|null</dt>
 <dd>A definition of a GET operation on this path.</dd>
 <dt>put : OpenApi\Attributes\Put|null</dt>
 <dd>A definition of a PUT operation on this path.</dd>
 <dt>post : OpenApi\Attributes\Post|null</dt>
 <dd>A definition of a POST operation on this path.</dd>
 <dt>delete : OpenApi\Attributes\Delete|null</dt>
 <dd>A definition of a DELETE operation on this path.</dd>
 <dt>options : OpenApi\Attributes\Options|null</dt>
 <dd>A definition of a OPTIONS operation on this path.</dd>
 <dt>head : OpenApi\Attributes\Head|null</dt>
 <dd>A definition of a HEAD operation on this path.</dd>
 <dt>patch : OpenApi\Attributes\Patch|null</dt>
 <dd>A definition of a PATCH operation on this path.</dd>
 <dt>trace : OpenApi\Attributes\Trace|null</dt>
 <dd>A definition of a TRACE operation on this path.</dd>
 <dt>servers : Server[]|null</dt>
 <dd>An alternative server array to service all operations in this path.</dd>
 <dt>parameters : Parameter[]|null</dt>
 <dd>A list of parameters that are applicable for all the operations described under this path. 
 
These parameters can be overridden at the operation level, but cannot be removed there. 
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.</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [Xml](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Xml.php)

#### Allowed in
---
<a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#schema">Schema</a>, <a href="#items">Items</a>, <a href="#xmlcontent">XmlContent</a>

#### Nested elements
---
<a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
 <dt>name : string|null</dt>
 <dd>Replaces the name of the element/attribute used for the described schema property. 
 
When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. 
When defined alongside type being array (outside the items), it will affect the wrapping element 
and only if wrapped is <code>true</code>. 
 
If wrapped is <code>false</code>, it will be ignored.</dd>
 <dt>namespace : string|null</dt>
 <dd>The URL of the namespace definition. Value SHOULD be in the form of a URL.</dd>
 <dt>prefix : string|null</dt>
 <dd>The prefix to be used for the name.</dd>
 <dt>attribute : bool|null</dt>
 <dd>Declares whether the property definition translates to an attribute instead of an element. 
 
Default value is <code>false</code>.</dd>
 <dt>wrapped : bool|null</dt>
 <dd>MAY be used only for an array definition. 
 
Signifies whether the array is wrapped (for example <code>&lt;books>&lt;book/>&lt;book/>&lt;/books></code>) 
or unwrapped (<code>&lt;book/>&lt;book/></code>). 
 
Default value is false. The definition takes effect only when defined alongside type being array (outside the items).</dd>
 <dt>x : array&lt;string,mixed&gt;|null</dt>
 <dd>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 
The keys inside the array will be prefixed with `x-`.</dd>
 <dt>attachables : Attachable[]|null</dt>
 <dd>Arbitrary attachables for this annotation. 
These will be ignored but can be used for custom processing.</dd>
</dl>

### [XmlContent](https://github.com/zircote/swagger-php/tree/master/src/Attributes/XmlContent.php)