Annotation Reference #

Nested elements

Response, Parameter, PathParameter, RequestBody, Examples, Header, SecurityScheme, Link, Schema, Attachable

Properties

callbacks : array

Reusable Callbacks.

Required:

Reference

OAI Components Object

Contact

Contact information for the exposed API.

Allowed in

Info

Nested elements

Properties

name : string

The identifying name of the contact person/organization.

Required:

url : string

The URL pointing to the contact information.

Required:

email : string

The email address of the contact person/organization.

Required:

Reference

OAI Contact Object

CookieParameter

A @OA\Request cookie parameter.

Allowed in

Components, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace

Nested elements

Properties

in

This takes 'cookie' as the default location.

Required:

yes

Delete

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

Discriminator

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

Schema, Property, AdditionalProperties, Items, JsonContent, XmlContent

Nested elements

Properties

propertyName : string

The name of the property in the payload that will hold the discriminator value.

Required:

yes

mapping : string[]

An object to hold mappings between payload values and schema names or references.

Required:

Reference

Examples

Allowed in

Components, Schema, Parameter, PathParameter, MediaType, JsonContent, XmlContent

Nested elements

Properties

ref : string|class-string|object

The relative or absolute path to an example.

Required:	no
See:	Using refs

example : string

The key into `#/components/examples`.

Required:

summary : string

Short description for the example.

Required:

yes

description : string

Embedded literal example.

The value field and externalValue field are mutually exclusive.

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

Required:

value : int|string|array

Required:

externalValue : string

An URL that points to the literal example.

This provides the capability to reference examples that cannot easily be included
in JSON or YAML documents.

The value field and externalValue field are mutually exclusive.

Required:

ExternalDocumentation

Allows referencing an external resource for extended documentation.

Allowed in

OpenApi, Tag, Schema, AdditionalProperties, Property, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace, Items, JsonContent, XmlContent

Nested elements

Properties

description : string

A short description of the target documentation. GFM syntax can be used for rich text representation.

Required:

url : string

The URL for the target documentation.

Required:

yes

Reference

OAI External Documentation Object

Flow

Configuration details for a supported OAuth Flow.

Allowed in

SecurityScheme

Nested elements

Properties

authorizationUrl : string

The authorization url to be used for this flow.

This must be in the form of an url.

Required:

tokenUrl : string

The token URL to be used for this flow.

This must be in the form of an url.

Required:

refreshUrl : string

The URL to be used for obtaining refresh tokens.

This must be in the form of an url.

Required:

flow : string

Flow name.

One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].

Required:

yes

scopes : array

The available scopes for the OAuth2 security scheme.

A map between the scope name and a short description for it.

Required:

yes

Reference

OAI OAuth Flow Object

Get

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

Head

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

Allowed in

Components, Response

Nested elements

Schema, Attachable

Properties

ref : string|class-string|object

The relative or absolute path to the endpoint.

Required:	no
See:	Using refs

header : string

No details available.

Required:

yes

description : string

A brief description of the parameter.

This could contain examples of use.
CommonMark syntax MAY be used for rich text representation.

Required:

required : bool

No details available.

Required:

deprecated : bool

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

Required:

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.

Required:

Reference

OAI Header Object.

HeaderParameter

A @OA\Request header parameter.

Allowed in

Components, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace

Nested elements

Properties

in

This takes 'header' as the default location.

Required:

yes

Info

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

Nested elements

Contact, License, Attachable

Properties

title : string

The title of the application.

Required:

yes

description : string

A short description of the application.

CommonMark syntax may be used for rich text representation.

Required:

termsOfService : string

An URL to the Terms of Service for the API.

Must be in the format of an url.

Required:

version : string

The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

Required:

yes

Reference

OAI Info Object

Items

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

Allowed in

Property, AdditionalProperties, Schema, JsonContent, XmlContent, Items

Nested elements

Discriminator, Items, Property, ExternalDocumentation, Xml, AdditionalProperties, Attachable

JsonContent

Shorthand for a json response.

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

Nested elements

Discriminator, Items, Property, ExternalDocumentation, AdditionalProperties, Examples, Attachable

License

License information for the exposed API.

Allowed in

Info

Nested elements

Properties

name : string

The license name used for the API.

Required:

yes

identifier : string

An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.

Required:

url : string

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.

Required:

Reference

OAI License Object

Link

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

Components, Response

Nested elements

Server, Attachable

Properties

ref : string|class-string|object

No details available.

Required:	no
See:	Using refs

link : string

The key into MediaType->links array.

Required:

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.

Required:

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.

Required:

parameters : array<string,mixed>

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).

Required:

requestBody

A literal value or {expression} to use as a request body when calling the target operation.

Required:

description : string

A description of the link.

CommonMark syntax may be used for rich text representation.

Required:

Reference

OAI Link Object

MediaType

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

Allowed in

Response, RequestBody

Nested elements

Properties

mediaType : string

The key into Operation->content array.

Required:

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.

Required:

encoding : array<string,mixed>

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.

Required:

Reference

OAI Media Type Object

OpenApi

This is the root document object for the API specification.

Nested elements

Info, Server, PathItem, Components, Tag, ExternalDocumentation, Webhook, Attachable

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.

A version specified via `Generator::setVersion()` will overwrite this value.

This is not related to the API info::version string.

Required:

yes

security : array

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.

Required:

Reference

OAI OpenApi Object

Options

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

Parameter

Describes a single operation parameter.

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

Allowed in

Components, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace

Nested elements

Properties

ref : string|class-string|object

The relative or absolute path to the endpoint.

Required:	no
See:	Using refs

parameter : string

The key into Components::parameters or PathItem::parameters array.

Required:

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.

Required:

yes

in : string

The location of the parameter.

Possible values are "query", "header", "path" or "cookie".

Required:

yes

description : string

A brief description of the parameter.

This could contain examples of use.

CommonMark syntax may be used for rich text representation.

Required:

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.

Required:

deprecated : bool

Specifies that a parameter is deprecated and should be transitioned out of usage.

Required:

allowEmptyValue : bool

Required:

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.

Required:

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.

Required:

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.

Required:

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.

Required:

content : array<MediaType>|JsonContent|XmlContent|Attachable

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.

Required:

matrix

Path-style parameters defined by RFC6570.

Required:	no
See:	RFC6570

label

Label style parameters defined by RFC6570.

Required:	no
See:	RFC6570

form

Form style parameters defined by RFC6570.

This option replaces collectionFormat with a csv (when explode is false) or multi (when explode is true) value from OpenAPI 2.0.

Required:	no
See:	RFC6570

simple : array

Simple style parameters defined by RFC6570.

This option replaces collectionFormat with a csv value from OpenAPI 2.0.

Required:	no
See:	RFC6570

spaceDelimited : array

Space separated array values.

This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:

pipeDelimited : array

Pipe separated array values.

This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:

deepObject

Provides a simple way of rendering nested objects using form parameters.

Required:

Reference

OAA Parameter Object

Patch

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

PathItem

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

Nested elements

Get, Post, Put, Delete, Patch, Trace, Head, Options, Parameter, PathParameter, Server, Attachable

Properties

ref : string|class-string|object

No details available.

Required:	no
See:	Using refs

summary : string

An optional, string summary, intended to apply to all operations in this path.

Required:

description : string

An optional, string description, intended to apply to all operations in this path.

Required:

path : string

Key for the Path Object (OpenApi->paths array).

Required:

Reference

OAI Path Item Object

PathParameter

A @OA\Request path parameter.

Allowed in

Components, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace

Nested elements

Properties

in

This takes 'path' as the default location.

Required:

required

No details available.

Required:

Post

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

Property

Allowed in

AdditionalProperties, Schema, JsonContent, XmlContent, Property, Items

Nested elements

Discriminator, Items, Property, ExternalDocumentation, Xml, AdditionalProperties, Attachable

Properties

property : string

The key into Schema->properties array.

Required:

Put

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

QueryParameter

A @OA\Request query parameter.

Allowed in

Components, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace

Nested elements

ServerVariable, Attachable

Properties

in

This takes 'query' as the default location.

Required:

yes

RequestBody

Describes a single request body.

Allowed in

Components, Delete, Get, Head, Operation, Options, Patch, Post, Trace, Put

Nested elements

MediaType, Attachable

Properties

ref : string|class-string|object

The relative or absolute path to a request body.

Required:	no
See:	Using refs

request : string

The key into Components->requestBodies array.

Required:

description : string

A brief description of the parameter.

This could contain examples of use.

CommonMark syntax may be used for rich text representation.

Required:

required : bool

Required:

Reference

OAI Request Body Object

Response

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

Allowed in

Components, Operation, Get, Post, Put, Patch, Delete, Head, Options, Trace

Nested elements

MediaType, Header, Link, Attachable

Properties

ref : string|class-string|object

The relative or absolute path to a response.

Required:	no
See:	Using refs

response : string|int

The key into Operations->responses array.

A HTTP status code or default.

Required:

description : string

A short description of the response.

CommonMark syntax may be used for rich text representation.

Required:

Reference

OAI Response Object

Schema

The definition of input and output data types.

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

Allowed in

Components, Parameter, PathParameter, MediaType, Header

Nested elements

Discriminator, Items, Property, ExternalDocumentation, Examples, Xml, AdditionalProperties, Attachable

Properties

ref : string|class-string|object

The relative or absolute path to the endpoint.

Required:	no
See:	Using refs

schema : string

The key into Components->schemas array.

Required:

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.

Required:

description : string

A description will provide explanation about the purpose of the instance described by this schema.

Required:

maxProperties : int

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.

Required:

minProperties : int

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.

Required:

required : string[]

An object instance is valid against this property if its property set contains all elements in this property's
array value.

Required:

type : string|non-empty-array<string>

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.

Required:

format : string

The extending format for the previously mentioned type. See Data Type Formats for further details.

Required:

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.

Required:

default

Sets a default value to the parameter. The type of the value depends on the defined type.

Required:	no
See:	JSON schema validation

maximum : int|float

The maximum value allowed for a numeric property. This value must be a number.

Required:	no
See:	JSON schema validation

exclusiveMaximum : bool|int|float

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.

Required:	no
See:	JSON schema validation

minimum : int|float

The minimum value allowed for a numeric property. This value must be a number.

Required:	no
See:	JSON schema validation

exclusiveMinimum : bool|int|float

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.

Required:	no
See:	JSON schema validation

maxLength : int

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.

Required:	no
See:	JSON schema validation

minLength : int

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.

Required:	no
See:	JSON schema validation

pattern : string

A string instance is considered valid if the regular expression matches the instance successfully.

Required:

maxItems : int

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.

Required:	no
See:	JSON schema validation

minItems : int

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.

Required:	no
See:	JSON schema validation

uniqueItems : bool

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.

Required:	no
See:	JSON schema validation

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.

Required:	no
See:	JSON schema validation

multipleOf : int|float

A numeric instance is valid against "multipleOf" if the result of the division of the instance by this
property's value is an integer.

Required:

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.

Required:

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.

Required:

example

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.

Required:

nullable : bool

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.

Required:

deprecated : bool

Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.

Required:

allOf : array<Schema|\OpenApi\Attributes\Schema>

An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.

Required:

anyOf : array<Schema|\OpenApi\Attributes\Schema>

An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.

Required:

oneOf : array<Schema|\OpenApi\Attributes\Schema>

An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.

Required:

not

http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.29.

Required:

additionalItems

http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.10.

Required:

contains

http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.14.

Required:

patternProperties

http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.19.

Required:

dependencies

http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.21.

Required:

propertyNames

http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.22.

Required:

const

http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.

Required:

Reference

SecurityScheme

Allowed in

Components

Nested elements

Flow, Attachable

Properties

ref : string|class-string|object

The relative or absolute path to a security scheme.

Required:	no
See:	Using refs

securityScheme : string

The key into OpenApi->security array.

Required:

yes

type : string|non-empty-array<string>

The type of the security scheme.

Required:

yes

description : string

A short description for security scheme.

Required:

name : string

The name of the header or query parameter to be used.

Required:

in : string

Required The location of the API key.

Required:

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.

Required:

scheme : string

The name of the HTTP Authorization scheme.

Required:	no
See:	RFC7235

openIdConnectUrl : string

OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.

Required:

Reference

OAI Security Scheme Object.

Server

An object representing a server.

Allowed in

OpenApi, PathItem, Operation, Get, Post, Put, Delete, Patch, Head, Options, Trace, Link

Nested elements

Properties

url : string

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}.

Required:

yes

description : string

An optional string describing the host designated by the URL.

CommonMark syntax may be used for rich text representation.

Required:

Reference

OAI Server Object

ServerVariable

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

Allowed in

Server

Nested elements

Properties

serverVariable : string

The key into Server->variables array.

Required:

An enumeration of values to be used if the substitution options are from a limited set.

Required:

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.

Required:

yes

variables : array

A map between a variable name and its value.

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

Required:

description : string

An optional description for the server variable.

CommonMark syntax MAY be used for rich text representation.

Required:

Reference

OAI Server Variable Object

Trace

Allowed in

Nested elements

Parameter, PathParameter, Response, ExternalDocumentation, Server, RequestBody, Attachable

Properties

method

No details available.

Required:

Webhook

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

Allowed in

Nested elements

Get, Post, Put, Delete, Patch, Trace, Head, Options, Parameter, PathParameter, Server, Attachable

Properties

webhook : string

Key for the webhooks map.

Required:

yes

Xml

Allowed in

AdditionalProperties, Schema, Property, Schema, Items, XmlContent

Nested elements