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: annotations.md

# Annotation 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.

## Annotations
### [AdditionalProperties](https://github.com/zircote/swagger-php/tree/master/src/Annotations/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>

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

A container for custom data to be attached to an annotation.

These will be ignored by `swagger-php` but can be used for custom processing.

#### 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>

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

Holds a set of reusable objects for different aspects of the OA.

All objects defined within the components object will have no effect on the API unless they are explicitly
referenced from properties outside the components object.

#### 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>

#### Properties
---
<dl>
 <dt>callbacks : array</dt>
 <dd>Reusable Callbacks.</dd>
</dl>

#### Reference
---
- [OAI Components Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object)

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

Contact information for the exposed API.

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

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

#### Properties
---
<dl>
 <dt>name : string</dt>
 <dd>The identifying name of the contact person/organization.</dd>
 <dt>url : string</dt>
 <dd>The URL pointing to the contact information.</dd>
 <dt>email : string</dt>
 <dd>The email address of the contact person/organization.</dd>
</dl>

#### Reference
---
- [OAI Contact Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object)

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

A `@OA\Request` cookie parameter.

#### 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>

#### Properties
---
<dl>
 <dt>in</dt>
 <dd>This takes 'cookie' as the default location.</dd>
</dl>

### [Delete](https://github.com/zircote/swagger-php/tree/master/src/Annotations/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>

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

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

The discriminator is a specific object in a schema which is used to inform the consumer of
the specification of an alternative schema based on the value associated with it.

This object is based on the [JSON Schema Specification](http://json-schema.org) and uses a predefined subset of it.
On top of this subset, there are extensions provided by this specification to allow for more complete documentation.

#### 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>

#### Properties
---
<dl>
 <dt>propertyName : string</dt>
 <dd>The name of the property in the payload that will hold the discriminator value.</dd>
 <dt>mapping : string[]</dt>
 <dd>An object to hold mappings between payload values and schema names or references.</dd>
</dl>

#### Reference
---
- [OAI Discriminator Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminatorObject)
- [JSON Schema](http://json-schema.org/)

### [Examples](https://github.com/zircote/swagger-php/tree/master/src/Annotations/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>

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

Allows referencing an external resource for extended documentation.

#### 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>

#### Properties
---
<dl>
 <dt>description : string</dt>
 <dd>A short description of the target documentation. GFM syntax can be used for rich text representation.</dd>
 <dt>url : string</dt>
 <dd>The URL for the target documentation.</dd>
</dl>

#### Reference
---
- [OAI External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#external-documentation-object)

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

Configuration details for a supported OAuth Flow.

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

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

#### Properties
---
<dl>
 <dt>authorizationUrl : string</dt>
 <dd>The authorization url to be used for this flow. 
 
This must be in the form of an url.</dd>
 <dt>tokenUrl : string</dt>
 <dd>The token URL to be used for this flow. 
 
This must be in the form of an url.</dd>
 <dt>refreshUrl : string</dt>
 <dd>The URL to be used for obtaining refresh tokens. 
 
This must be in the form of an url.</dd>
 <dt>flow : string</dt>
 <dd>Flow name. 
 
One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].</dd>
 <dt>scopes : array</dt>
 <dd>The available scopes for the OAuth2 security scheme. 
 
A map between the scope name and a short description for it.</dd>
</dl>

#### Reference
---
- [OAI OAuth Flow Object](https://swagger.io/specification/#oauthFlowObject)

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

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

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

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

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

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

### [Header](https://github.com/zircote/swagger-php/tree/master/src/Annotations/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>

#### Reference
---
- [OAI Header Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject).

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

A `@OA\Request` header parameter.

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

#### Properties
---
<dl>
 <dt>in</dt>
 <dd>This takes 'header' as the default location.</dd>
</dl>

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

The object provides metadata about the API.

The metadata may be used by the clients if needed and may be presented in editing or documentation generation tools for convenience.

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

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

#### Properties
---
<dl>
 <dt>title : string</dt>
 <dd>The title of the application.</dd>
 <dt>description : string</dt>
 <dd>A short description of the application. 
 
CommonMark syntax may be used for rich text representation.</dd>
 <dt>termsOfService : string</dt>
 <dd>An URL to the Terms of Service for the API. 
 
Must be in the format of an url.</dd>
 <dt>version : string</dt>
 <dd>The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).</dd>
</dl>

#### Reference
---
- [OAI Info Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object)

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

The description of an item in a Schema with type `array`.

#### 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/Annotations/JsonContent.php)

Shorthand for a json response.

Use as `@OA\Schema` inside a `Response` and `MediaType`->`'application/json'` will be generated.

#### 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>

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

License information for the exposed API.

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

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

#### Properties
---
<dl>
 <dt>name : string</dt>
 <dd>The license name used for the API.</dd>
 <dt>identifier : string</dt>
 <dd>An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.</dd>
 <dt>url : string</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>
</dl>

#### Reference
---
- [OAI License Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object)

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

The Link object represents a possible design-time link for a response.

The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known
relationship and traversal mechanism between responses and other operations.

Unlike dynamic links (i.e. links provided in the response payload), the OA linking mechanism does not require
link information in the runtime response.

For computing links, and providing instructions to execute them, a runtime expression is used for
accessing values in an operation and using them as parameters while invoking the linked operation.

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

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

#### Properties
---
<dl>
 <dt>ref : string|class-string|object</dt>
 <dd>No details available.See: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></dd>
 <dt>link : string</dt>
 <dd>The key into MediaType->links array.</dd>
 <dt>operationRef : string</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>operationId : string</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</dt>
 <dd>A literal value or {expression} to use as a request body when calling the target operation.</dd>
 <dt>description : string</dt>
 <dd>A description of the link. 
 
CommonMark syntax may be used for rich text representation.</dd>
</dl>

#### Reference
---
- [OAI Link Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object)

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

Each Media Type object provides schema and examples for the media type identified by its key.

#### 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>

#### Properties
---
<dl>
 <dt>mediaType : string</dt>
 <dd>The key into Operation->content array.</dd>
 <dt>example</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>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>
</dl>

#### Reference
---
- [OAI Media Type Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object)

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

This is the root document object for the API specification.

#### 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>

#### Properties
---
<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>security : array</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>
</dl>

#### Reference
---
- [OAI OpenApi Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#openapi-object)

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

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

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

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

Describes a single operation parameter.

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

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

#### Reference
---
- [OAA Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object)

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

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

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

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

Describes the operations available on a single path.

A Path Item may be empty, due to ACL constraints.
The path itself is still exposed to the documentation viewer, but they will not know which operations and parameters are available.

#### 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>

#### Reference
---
- [OAI Path Item Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object)

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

A `@OA\Request` path parameter.

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

#### Properties
---
<dl>
 <dt>in</dt>
 <dd>This takes 'path' as the default location.</dd>
 <dt>required</dt>
 <dd>No details available.</dd>
</dl>

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

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

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

### [Property](https://github.com/zircote/swagger-php/tree/master/src/Annotations/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>

#### Properties
---
<dl>
 <dt>property : string</dt>
 <dd>The key into Schema->properties array.</dd>
</dl>

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

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

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

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

A `@OA\Request` query parameter.

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

#### Properties
---
<dl>
 <dt>in</dt>
 <dd>This takes 'query' as the default location.</dd>
</dl>

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

Describes a single request body.

#### 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>

#### Reference
---
- [OAI Request Body Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#requestBodyObject)

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

Describes a single response from an API Operation, including design-time,
static links to operations based on the response.

#### 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>

#### Reference
---
- [OAI Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object)

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

The definition of input and output data types.

These types can be objects, but also primitives and arrays.

#### 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>

#### Properties
---
<dl>
 <dt>ref : string|class-string|object</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</dt>
 <dd>The key into Components->schemas array.</dd>
 <dt>title : string</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</dt>
 <dd>A description will provide explanation about the purpose of the instance described by this schema.</dd>
 <dt>maxProperties : int</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</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>type : string|non-empty-array&lt;string&gt;</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</dt>
 <dd>The extending format for the previously mentioned type. See Data Type Formats for further details.</dd>
 <dt>collectionFormat : string</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</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 : bool|int|float</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 : bool|int|float</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</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</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>pattern : string</dt>
 <dd>A string instance is considered valid if the regular expression matches the instance successfully.</dd>
 <dt>maxItems : int</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</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</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>enum : array&lt;string|int|float|bool|\UnitEnum&gt;|class-string</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>multipleOf : int|float</dt>
 <dd>A numeric instance is valid against "multipleOf" if the result of the division of the instance by this 
property's value is an integer.</dd>
 <dt>readOnly : bool</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</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>example</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</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</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\Attributes\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\Attributes\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\Attributes\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>not</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.29.</dd>
 <dt>additionalItems</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.10.</dd>
 <dt>contains</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.14.</dd>
 <dt>patternProperties</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.19.</dd>
 <dt>dependencies</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.21.</dd>
 <dt>propertyNames</dt>
 <dd>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.22.</dd>
 <dt>const</dt>
 <dd>http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.</dd>
</dl>

#### Reference
---
- [OAI Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject)
- [JSON Schema](http://json-schema.org/)

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

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

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

#### Reference
---
- [OAI Security Scheme Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject).

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

An object representing a server.

#### 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>

#### Properties
---
<dl>
 <dt>url : string</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</dt>
 <dd>An optional string describing the host designated by the URL. 
 
CommonMark syntax may be used for rich text representation.</dd>
</dl>

#### Reference
---
- [OAI Server Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object)

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

An object representing a server variable for server URL template substitution.

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

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

#### Properties
---
<dl>
 <dt>serverVariable : string</dt>
 <dd>The key into Server->variables array.</dd>
 <dt>enum : array&lt;string|int|float|bool|\UnitEnum&gt;|class-string</dt>
 <dd>An enumeration of values to be used if the substitution options are from a limited set.</dd>
 <dt>default : string</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>variables : array</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>description : string</dt>
 <dd>An optional description for the server variable. 
 
CommonMark syntax MAY be used for rich text representation.</dd>
</dl>

#### Reference
---
- [OAI Server Variable Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object)

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

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

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

#### Properties
---
<dl>
 <dt>name : string</dt>
 <dd>The name of the tag.</dd>
 <dt>description : string</dt>
 <dd>A short description for the tag. GFM syntax can be used for rich text representation.</dd>
</dl>

#### Reference
---
- [OAI Tag Object]( https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#tagObject).

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

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

#### Properties
---
<dl>
 <dt>method</dt>
 <dd>No details available.</dd>
</dl>

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

Acts like a `PathItem` with the main difference being that it requires `webhook` instead of `path`.

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

#### Properties
---
<dl>
 <dt>webhook : string</dt>
 <dd>Key for the webhooks map.</dd>
</dl>

### [Xml](https://github.com/zircote/swagger-php/tree/master/src/Annotations/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>

#### Properties
---
<dl>
 <dt>name : string</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</dt>
 <dd>The URL of the namespace definition. Value SHOULD be in the form of a URL.</dd>
 <dt>prefix : string</dt>
 <dd>The prefix to be used for the name.</dd>
 <dt>attribute : bool</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</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>
</dl>

#### Reference
---
- [OAI XML Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#xmlObject).

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

Shorthand for a xml response.

Use as `@OA\Schema` inside a `Response` and `MediaType`->`'application/xml'` will be generated.