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

schemas : Schema[]: Reusable Schemas.
responses : Response[]: Reusable Responses.
parameters : Parameter[]: Reusable Parameters.
examples : array: Reusable Examples.
requestBodies : RequestBody[]: Reusable Request Bodys.
headers : Header[]: Reusable Headers.
securitySchemes : SecurityScheme[]: Reusable Security Schemes.
links : Link[]: Reusable Links.
callbacks : callable[]: Reusable Callbacks.

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

name : string: The identifying name of the contact person/organization.
url : string: The URL pointing to the contact information.
email : string: The email address of the contact person/organization.

#### Reference - [OAI Contact Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object) ## [Delete](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Delete.php) #### Properties

method: No details available.

## [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. #### Properties

propertyName : string: The name of the property in the payload that will hold the discriminator value.
mapping : string[]: An object to hold mappings between payload values and schema names or references.

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

ref : string: No details available.
example : string: The key into `#/components/examples`.
summary : string: Short description for the example.
description : string: Embedded literal example.

The value field and externalValue field are mutually exclusive.

To represent examples of media types that cannot naturally represented
in JSON or YAML, use a string value to contain the example, escaping where necessary.
value : string: Embedded literal example.

The value field and externalValue field are mutually exclusive.

To represent examples of media types that cannot naturally represented
in JSON or YAML, use a string value to contain the example, escaping where necessary.
externalValue : string: A 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.

## [ExternalDocumentation](https://github.com/zircote/swagger-php/tree/master/src/Annotations/ExternalDocumentation.php) Allows referencing an external resource for extended documentation. #### Properties

description : string: A short description of the target documentation. GFM syntax can be used for rich text representation.
url : string: The URL for the target documentation.

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

authorizationUrl : string: The authorization url to be used for this flow.

This must be in the form of a url.
tokenUrl : string: The token URL to be used for this flow.

This must be in the form of a url.
refreshUrl : string: The URL to be used for obtaining refresh tokens.

This must be in the form of a url.
flow : string: Flow name. One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].
scopes: The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.

#### Reference - [OAI OAuth Flow Object](https://swagger.io/specification/#oauthFlowObject) ## [Get](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Get.php) #### Properties

method: No details available.

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

method: No details available.

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

ref : string: No details available.
header : string: No details available.
description : string: No details available.
required : bool: A brief description of the parameter.

This could contain examples of use.
CommonMark syntax MAY be used for rich text representation.
schema : \OpenApi\Annotations\Schema: Schema object.
deprecated : bool: Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
allowEmptyValue : bool: 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.

#### Reference - [OAI Header Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject). ## [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. #### Properties

title : string: The title of the application.
description : string: A short description of the application.

CommonMark syntax may be used for rich text representation.
termsOfService : string: A URL to the Terms of Service for the API.

Must be in the format of a url.
contact : Contact: The contact information for the exposed API.
license : License: The license information for the exposed API.
version : string: The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

#### 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`. ## [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. #### Properties

examples : array: No details available.

## [License](https://github.com/zircote/swagger-php/tree/master/src/Annotations/License.php) License information for the exposed API. #### Properties

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

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

ref : string: No details available.
link : string: The key into MediaType->links array.
operationRef : string: A relative or absolute reference to an OA operation.

This field is mutually exclusive of the operationId field, and must point to an Operation object.

Relative values may be used to locate an existing Operation object in the OpenAPI definition.
operationId : string: The name of an existing, resolvable OA operation, as defined with a unique operationId.

This field is mutually exclusive of the operationRef field.
parameters: 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).
requestBody: A literal value or {expression} to use as a request body when calling the target operation.
description : string: A description of the link.

CommonMark syntax may be used for rich text representation.
server : Server: A server object to be used by the target operation.

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

mediaType : string: The key into Operation->content array.
schema : Schema: The schema defining the type used for the request body.
example: 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.
examples : array: Examples of the media type.

Each example object should match the media type and specified schema if present.
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.
encoding: 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.

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

openapi : string: 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.
This is not related to the API info::version string.
info : Info: Provides metadata about the API. The metadata may be used by tooling as required.
servers : Server[]: An array of @OA\Server 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 a url value of /.
paths : PathItem[]: The available paths and operations for the API.
components : Components: An element to hold various components for the specification.
security : array: Lists the required security schemes to execute this operation.

The name used for each property must correspond to a security scheme declared
in the Security Schemes under the Components Object.
Security Requirement Objects that contain multiple schemes require that
all schemes must be satisfied for a request to be authorized.
This enables support for scenarios where multiple query parameters or
HTTP headers are required to convey security information.
When a list of Security Requirement Objects is defined on the Open API object or
Operation Object, only one of Security Requirement Objects in the list needs to
be satisfied to authorize the request.
tags : Tag[]: 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.
externalDocs : ExternalDocumentation: Additional external documentation.

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

method: No details available.

## [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. #### Properties

ref : string: No details available.
parameter : string: The key into Components->parameters or PathItem->parameters array.
name : string: 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.
in : string: The location of the parameter.

Possible values are "query", "header", "path" or "cookie".
description : string: A brief description of the parameter.

This could contain examples of use.

CommonMark syntax may be used for rich text representation.
required : bool: 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.
deprecated : bool: Specifies that a parameter is deprecated and should be transitioned out of usage.
allowEmptyValue : bool: 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.
style : string: 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.
explode : bool: 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.
allowReserved : bool: 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.
schema : Schema: The schema defining the type used for the parameter.
example: 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.
examples : array: 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.
content : MediaType[]: 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.
matrix: Path-style parameters defined by https://tools.ietf.org/html/rfc6570#section-3.2.7.
label: Label style parameters defined by https://tools.ietf.org/html/rfc6570#section-3.2.5.
form: Form style parameters defined by https://tools.ietf.org/html/rfc6570#section-3.2.8

This option replaces collectionFormat with a csv (when explode is false) or multi (when explode is true) value from OpenAPI 2.0.
simple : array: Simple style parameters defined by https://tools.ietf.org/html/rfc6570#section-3.2.2

This option replaces collectionFormat with a csv value from OpenAPI 2.0.
spaceDelimited : array: Space separated array values.

This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
pipeDelimited : array: Pipe separated array values.

This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
deepObject: Provides a simple way of rendering nested objects using form parameters.

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

method: No details available.

## [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. #### Properties

ref : string: No details available.
path : string: key for the Path Object (OpenApi->paths array).
summary : string: An optional, string summary, intended to apply to all operations in this path.
get : Get: A definition of a GET operation on this path.
put : Put: A definition of a PUT operation on this path.
post : Post: A definition of a POST operation on this path.
delete : Delete: A definition of a DELETE operation on this path.
options : Options: A definition of a OPTIONS operation on this path.
head : Head: A definition of a HEAD operation on this path.
patch : Patch: A definition of a PATCH operation on this path.
trace : Trace: A definition of a TRACE operation on this path.
servers : Server[]: An alternative server array to service all operations in this path.
parameters : Parameter[]: 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.

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

in: No details available.
required: No details available.

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

method: No details available.

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

property : string: The key into Schema->properties array.

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

method: No details available.

## [RequestBody](https://github.com/zircote/swagger-php/tree/master/src/Annotations/RequestBody.php) Describes a single request body. #### Properties

ref: No details available.
request : string: Request body model name.
description : string: A brief description of the parameter.

This could contain examples of use.

CommonMark syntax may be used for rich text representation.
required : bool: 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.
content : array<MediaType>|JsonContent|XmlContent: The content of the request body.

The key is a media type or media type range and the value describes it. For requests that match multiple keys,
only the most specific key is applicable. e.g. text/plain overrides text/*.

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

ref : string: No details available.
response : string|int: The key into Operations->responses array.

A HTTP status code or default.
description : string: A short description of the response.

CommonMark syntax may be used for rich text representation.
headers : Header[]: Maps a header name to its definition.

RFC7230 states header names are case insensitive. https://tools.ietf.org/html/rfc7230#page-22
If a response header is defined with the name "Content-Type", it shall be ignored.
content : MediaType[]: A map containing descriptions of potential response payloads.

The key is a media type or media type range and the value describes it.
For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides
text/*.
links : array: A map of operations links that can be followed from the response.

The key of the map is a short name for the link, following the naming constraints of the names for Component
Objects.

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

ref : string: No details available.
schema : string: The key into Components->schemas array.
title : string: Can be used to decorate a user interface with information about the data produced by this user interface.

Preferably short; use description for more details.
description : string: A description will provide explanation about the purpose of the instance described by this schema.
maxProperties : int: An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the
value of this property.
minProperties : int: An object instance is valid against "minProperties" if its number of properties is greater than, or equal to,
the value of this property.
required : string[]: An object instance is valid against this property if its property set contains all elements in this property's
array value.
properties : Property[]: No details available.
type : string: The type of the schema/property. The value MUST be one of "string", "number", "integer", "boolean", "array" or
"object".
format : string: The extending format for the previously mentioned type. See Data Type Formats for further details.
items : Items: Required if type is "array". Describes the type of items in the array.
collectionFormat : string: 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 query or formData.
Default value is csv.
default: Sets a default value to the parameter. The type of the value depends on the defined type. See
http://json-schema.org/latest/json-schema-validation.html#anchor101.
maximum : number: See http://json-schema.org/latest/json-schema-validation.html#anchor17.
exclusiveMaximum : bool: See http://json-schema.org/latest/json-schema-validation.html#anchor17.
minimum : number: See http://json-schema.org/latest/json-schema-validation.html#anchor21.
exclusiveMinimum : bool: See http://json-schema.org/latest/json-schema-validation.html#anchor21.
maxLength : int: See http://json-schema.org/latest/json-schema-validation.html#anchor26.
minLength : int: See http://json-schema.org/latest/json-schema-validation.html#anchor29.
pattern : string: A string instance is considered valid if the regular expression matches the instance successfully.
maxItems : int: See http://json-schema.org/latest/json-schema-validation.html#anchor42.
minItems : int: See http://json-schema.org/latest/json-schema-validation.html#anchor45.
uniqueItems : bool: See http://json-schema.org/latest/json-schema-validation.html#anchor49.
enum : array: See http://json-schema.org/latest/json-schema-validation.html#anchor76.
multipleOf : number: A numeric instance is valid against "multipleOf" if the result of the division of the instance by this
property's value is an integer.
discriminator : Discriminator: 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.
readOnly : bool: 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.
writeOnly : bool: 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.
xml : Xml: 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.
externalDocs : ExternalDocumentation: Additional external documentation for this schema.
example: A free-form property to include an example of an instance for this schema.
To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to
contain the example with escaping where necessary.
nullable : bool: Allows sending a null value for the defined schema.
Default value is false.
deprecated : bool: Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.
allOf : Schema[]: An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.
anyOf : Schema[]: An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.
oneOf : Schema[]: An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.
not: http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.29.
additionalProperties : bool|AdditionalProperties: http://json-schema.org/latest/json-schema-validation.html#anchor64.
additionalItems: http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.10.
contains: http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.14.
patternProperties: http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.19.
dependencies: http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.21.
propertyNames: http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.22.
const: http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.24.

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

ref : string: No details available.
securityScheme : string: The key into OpenApi->security array.
type : string: The type of the security scheme.
description : string: A short description for security scheme.
name : string: The name of the header or query parameter to be used.
in : string: Required The location of the API key.
flows : Flow[]: The flow used by the OAuth2 security scheme.
bearerFormat : string: A hint to the client to identify how the bearer token is formatted.

Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
scheme : string: The name of the HTTP Authorization scheme.
openIdConnectUrl : string: OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.

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

url : string: A 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}.
description : string: An optional string describing the host designated by the URL.

CommonMark syntax may be used for rich text representation.
variables : array: A map between a variable name and its value.

The value is used for substitution in the server's URL template.

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

serverVariable : string: The key into Server->variables array.
enum : string[]: An enumeration of string values to be used if the substitution options are from a limited set.
default : string: 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.
variables : array: A map between a variable name and its value.

The value is used for substitution in the server's URL template.
description : string: An optional description for the server variable.

CommonMark syntax MAY be used for rich text representation.

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

name : string: The name of the tag.
description : string: A short description for the tag. GFM syntax can be used for rich text representation.
externalDocs : ExternalDocumentation: Additional external documentation for this tag.

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

method: No details available.

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

name : string: 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 true.

If wrapped is false, it will be ignored.
namespace : string: The URL of the namespace definition. Value SHOULD be in the form of a URL.
prefix : string: The prefix to be used for the name.
attribute : bool: Declares whether the property definition translates to an attribute instead of an element.

Default value is false.
wrapped : bool: MAY be used only for an array definition.

Signifies whether the array is wrapped (for example <books><book/><book/></books>)
or unwrapped (<book/><book/>).

Default value is false. The definition takes effect only when defined alongside type being array (outside the items).

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

examples : array: No details available.