# Attributes 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/Attributes/AdditionalProperties.php) #### Parameters
ref : object|string|null
No details available.
schema : string|null
No details available.
title : string|null
No details available.
description : string|null
No details available.
required : string[]|null
No details available.
properties : array|null
No details available.
type : string|null
No details available.
format : string|null
No details available.
items : OpenApi\Attributes\Items|null
No details available.
collectionFormat : string|null
No details available.
default
No details available.
maximum
No details available.
exclusiveMaximum : bool|null
No details available.
minimum
No details available.
exclusiveMinimum : bool|null
No details available.
maxLength : int|null
No details available.
minLength : int|null
No details available.
maxItems : int|null
No details available.
minItems : int|null
No details available.
uniqueItems : bool|null
No details available.
pattern : string|null
No details available.
enum : array|null
No details available.
discriminator : OpenApi\Attributes\Discriminator|null
No details available.
readOnly : bool|null
No details available.
writeOnly : bool|null
No details available.
xml : OpenApi\Attributes\Xml|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
example
No details available.
nullable : bool|null
No details available.
deprecated : bool|null
No details available.
allOf : array|null
No details available.
anyOf : array|null
No details available.
oneOf : array|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Attachable](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Attachable.php) #### Parameters
properties : array
No details available.
## [Components](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Components.php) #### Parameters
properties : array
No details available.
## [Contact](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Contact.php) #### Parameters
name : string|null
No details available.
url : string|null
No details available.
email : string|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Delete](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Delete.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Discriminator](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Discriminator.php) #### Parameters
propertyName : string|null
No details available.
mapping : string[]|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Examples](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Examples.php) #### Parameters
example : string|null
No details available.
summary : string|null
No details available.
description : string|null
No details available.
value : array|string|null
No details available.
externalValue : string|null
No details available.
ref : object|string|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [ExternalDocumentation](https://github.com/zircote/swagger-php/tree/master/src/Attributes/ExternalDocumentation.php) #### Parameters
description : string|null
No details available.
url : string|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Flow](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Flow.php) #### Parameters
authorizationUrl : string|null
No details available.
tokenUrl : string|null
No details available.
refreshUrl : string|null
No details available.
flow : string|null
No details available.
scopes : array|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Get](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Get.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Head](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Head.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Header](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Header.php) #### Parameters
ref : object|string|null
No details available.
header : string|null
No details available.
description : string|null
No details available.
required : bool|null
No details available.
schema : OpenApi\Attributes\Schema|null
No details available.
deprecated : bool|null
No details available.
allowEmptyValue : bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Info](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Info.php) #### Parameters
version : string|null
No details available.
description : string|null
No details available.
title : string|null
No details available.
termsOfService : string|null
No details available.
contact : OpenApi\Attributes\Contact|null
No details available.
license : OpenApi\Attributes\License|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Items](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Items.php) #### Parameters
ref : object|string|null
No details available.
schema : string|null
No details available.
title : string|null
No details available.
description : string|null
No details available.
required : string[]
No details available.
properties : Property[]
No details available.
type : string|null
No details available.
format : string|null
No details available.
items : OpenApi\Attributes\Items|null
No details available.
collectionFormat : string|null
No details available.
default
No details available.
maximum
No details available.
exclusiveMaximum : bool|null
No details available.
minimum
No details available.
exclusiveMinimum : bool|null
No details available.
maxLength : int|null
No details available.
minLength : int|null
No details available.
maxItems : int|null
No details available.
minItems : int|null
No details available.
uniqueItems : bool|null
No details available.
pattern : string|null
No details available.
enum : array|null
No details available.
discriminator : OpenApi\Attributes\Discriminator|null
No details available.
readOnly : bool|null
No details available.
writeOnly : bool|null
No details available.
xml : OpenApi\Attributes\Xml|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
example
No details available.
nullable : bool|null
No details available.
deprecated : bool|null
No details available.
allOf : array|null
No details available.
anyOf : array|null
No details available.
oneOf : array|null
No details available.
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [JsonContent](https://github.com/zircote/swagger-php/tree/master/src/Attributes/JsonContent.php) #### Parameters
examples : array<string,Examples>
No details available.
ref : object|string|null
No details available.
schema : string|null
No details available.
title : string|null
No details available.
description : string|null
No details available.
required : string[]
No details available.
properties : Property[]
No details available.
type : string|null
No details available.
format : string|null
No details available.
items : OpenApi\Attributes\Items|null
No details available.
collectionFormat : string|null
No details available.
default
No details available.
maximum
No details available.
exclusiveMaximum : bool|null
No details available.
minimum
No details available.
exclusiveMinimum : bool|null
No details available.
maxLength : int|null
No details available.
minLength : int|null
No details available.
maxItems : int|null
No details available.
minItems : int|null
No details available.
uniqueItems : bool|null
No details available.
pattern : string|null
No details available.
enum : array|null
No details available.
discriminator : OpenApi\Attributes\Discriminator|null
No details available.
readOnly : bool|null
No details available.
writeOnly : bool|null
No details available.
xml : OpenApi\Attributes\Xml|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
example
No details available.
nullable : bool|null
No details available.
deprecated : bool|null
No details available.
allOf : array|null
No details available.
anyOf : array|null
No details available.
oneOf : array|null
No details available.
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [License](https://github.com/zircote/swagger-php/tree/master/src/Attributes/License.php) #### Parameters
name : string|null
No details available.
identifier : string|null
No details available.
url : string|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Link](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Link.php) #### Parameters
link : string|null
No details available.
ref : object|string|null
No details available.
operationId : string|null
No details available.
parameters : array<string,mixed>
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [MediaType](https://github.com/zircote/swagger-php/tree/master/src/Attributes/MediaType.php) #### Parameters
mediaType : string|null
No details available.
schema : OpenApi\Attributes\Schema|null
No details available.
example
No details available.
examples : array<string,Examples>
No details available.
encoding : string|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [OpenApi](https://github.com/zircote/swagger-php/tree/master/src/Attributes/OpenApi.php) #### Parameters
openapi : string
No details available.
info : OpenApi\Attributes\Info|null
No details available.
servers : array|null
No details available.
tags : array|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Options](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Options.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Parameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Parameter.php) #### Parameters
parameter : string|null
No details available.
name : string|null
No details available.
description : string|null
No details available.
in : string|null
No details available.
required : bool|null
No details available.
ref : object|string|null
No details available.
schema : OpenApi\Attributes\Schema|null
No details available.
examples : array<string,Examples>
No details available.
style : string|null
No details available.
explode : bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Patch](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Patch.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [PathItem](https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathItem.php) #### Parameters
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [PathParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathParameter.php) #### Parameters
parameter : string|null
No details available.
name : string|null
No details available.
description : string|null
No details available.
in : string|null
No details available.
required : bool|null
No details available.
ref : object|string|null
No details available.
schema : OpenApi\Attributes\Schema|null
No details available.
examples : array<string,Examples>
No details available.
style : string|null
No details available.
explode : bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Post](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Post.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Property](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Property.php) #### Parameters
property : string|null
No details available.
ref : object|string|null
No details available.
schema : string|null
No details available.
title : string|null
No details available.
description : string|null
No details available.
required : string[]
No details available.
properties : Property[]
No details available.
type : string|null
No details available.
format : string|null
No details available.
items : OpenApi\Attributes\Items|null
No details available.
collectionFormat : string|null
No details available.
default
No details available.
maximum
No details available.
exclusiveMaximum : bool|null
No details available.
minimum
No details available.
exclusiveMinimum : bool|null
No details available.
maxLength : int|null
No details available.
minLength : int|null
No details available.
maxItems : int|null
No details available.
minItems : int|null
No details available.
uniqueItems : bool|null
No details available.
pattern : string|null
No details available.
enum : array|null
No details available.
discriminator : OpenApi\Attributes\Discriminator|null
No details available.
readOnly : bool|null
No details available.
writeOnly : bool|null
No details available.
xml : OpenApi\Attributes\Xml|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
example
No details available.
nullable : bool|null
No details available.
deprecated : bool|null
No details available.
allOf : array|null
No details available.
anyOf : array|null
No details available.
oneOf : array|null
No details available.
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Put](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Put.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [RequestBody](https://github.com/zircote/swagger-php/tree/master/src/Attributes/RequestBody.php) #### Parameters
description : string|null
No details available.
required : bool|null
No details available.
content : array<MediaType>|JsonContent|XmlContent|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Response](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Response.php) #### Parameters
ref : object|string|null
No details available.
response : string|int|null
No details available.
description : string|null
No details available.
headers : Header[]
No details available.
content
No details available.
links : Link[]
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Schema](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Schema.php) #### Parameters
ref : object|string|null
No details available.
schema : string|null
No details available.
title : string|null
No details available.
description : string|null
No details available.
required : string[]
No details available.
properties : array|null
No details available.
type : string|null
No details available.
format : string|null
No details available.
items : OpenApi\Attributes\Items|null
No details available.
collectionFormat : string|null
No details available.
default
No details available.
maximum
No details available.
exclusiveMaximum : bool|null
No details available.
minimum
No details available.
exclusiveMinimum : bool|null
No details available.
maxLength : int|null
No details available.
minLength : int|null
No details available.
maxItems : int|null
No details available.
minItems : int|null
No details available.
uniqueItems : bool|null
No details available.
pattern : string|null
No details available.
enum : string[]
No details available.
discriminator : OpenApi\Attributes\Discriminator|null
No details available.
readOnly : bool|null
No details available.
writeOnly : bool|null
No details available.
xml : OpenApi\Attributes\Xml|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
example
No details available.
nullable : bool|null
No details available.
deprecated : bool|null
No details available.
allOf : array|null
No details available.
anyOf : array|null
No details available.
oneOf : array|null
No details available.
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [SecurityScheme](https://github.com/zircote/swagger-php/tree/master/src/Attributes/SecurityScheme.php) #### Parameters
ref : object|string|null
No details available.
securityScheme : string|null
No details available.
type : string|null
No details available.
description : string|null
No details available.
name : string|null
No details available.
in : string|null
No details available.
bearerFormat : string|null
No details available.
scheme : string|null
No details available.
openIdConnectUrl : string|null
No details available.
flows : Flow[]
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Server](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Server.php) #### Parameters
url : string|null
No details available.
description : string|null
No details available.
variables : ServerVariable[]
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [ServerVariable](https://github.com/zircote/swagger-php/tree/master/src/Attributes/ServerVariable.php) #### Parameters
serverVariable : string|null
No details available.
description : string|null
No details available.
default : string|null
No details available.
enum : array|null
No details available.
variables : array|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Tag](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Tag.php) #### Parameters
name : string|null
No details available.
description : string|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Trace](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Trace.php) #### Parameters
path : string|null
No details available.
operationId : string|null
No details available.
description : string|null
No details available.
summary : string|null
No details available.
security : array
No details available.
servers : Server[]
No details available.
requestBody : OpenApi\Attributes\RequestBody|null
No details available.
tags : string[]
No details available.
parameters : Parameter[]
No details available.
responses : Response[]
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [Xml](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Xml.php) #### Parameters
name : string|null
No details available.
namespace : string|null
No details available.
prefix : string|null
No details available.
attribute : bool|null
No details available.
wrapped : bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.
## [XmlContent](https://github.com/zircote/swagger-php/tree/master/src/Attributes/XmlContent.php) #### Parameters
examples : array<string,Examples>
No details available.
ref : object|string|null
No details available.
schema : string|null
No details available.
title : string|null
No details available.
description : string|null
No details available.
required : string[]
No details available.
properties : Property[]
No details available.
type : string|null
No details available.
format : string|null
No details available.
items : OpenApi\Attributes\Items|null
No details available.
collectionFormat : string|null
No details available.
default
No details available.
maximum
No details available.
exclusiveMaximum : bool|null
No details available.
minimum
No details available.
exclusiveMinimum : bool|null
No details available.
maxLength : int|null
No details available.
minLength : int|null
No details available.
maxItems : int|null
No details available.
minItems : int|null
No details available.
uniqueItems : bool|null
No details available.
pattern : string|null
No details available.
enum : array|null
No details available.
discriminator : OpenApi\Attributes\Discriminator|null
No details available.
readOnly : bool|null
No details available.
writeOnly : bool|null
No details available.
xml : OpenApi\Attributes\Xml|null
No details available.
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
No details available.
example
No details available.
nullable : bool|null
No details available.
deprecated : bool|null
No details available.
allOf : array|null
No details available.
anyOf : array|null
No details available.
oneOf : array|null
No details available.
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
No details available.
x : array<string,string>|null
No details available.
attachables : Attachable[]|null
No details available.