From ee69aa172fa806edbb71b1d8fa84a9f8edadf500 Mon Sep 17 00:00:00 2001 From: Martin Rademacher Date: Mon, 6 Jan 2025 16:30:19 +1300 Subject: [PATCH] Update external links to OpenAPI spec (#1685) --- docs/reference/annotations.md | 346 +++--- docs/reference/attributes.md | 1246 ++++++++++----------- src/Annotations/Components.php | 2 +- src/Annotations/Contact.php | 2 +- src/Annotations/Discriminator.php | 2 +- src/Annotations/Examples.php | 2 +- src/Annotations/ExternalDocumentation.php | 2 +- src/Annotations/Flow.php | 4 +- src/Annotations/Header.php | 4 +- src/Annotations/Info.php | 2 +- src/Annotations/License.php | 2 +- src/Annotations/Link.php | 4 +- src/Annotations/MediaType.php | 2 +- src/Annotations/OpenApi.php | 2 +- src/Annotations/Operation.php | 2 +- src/Annotations/Parameter.php | 4 +- src/Annotations/PathItem.php | 4 +- src/Annotations/RequestBody.php | 4 +- src/Annotations/Response.php | 6 +- src/Annotations/Schema.php | 8 +- src/Annotations/SecurityScheme.php | 4 +- src/Annotations/Server.php | 2 +- src/Annotations/ServerVariable.php | 2 +- src/Annotations/Tag.php | 2 +- src/Annotations/Xml.php | 2 +- src/Serializer.php | 2 - tools/src/Docs/RefGenerator.php | 4 +- 27 files changed, 834 insertions(+), 834 deletions(-) diff --git a/docs/reference/annotations.md b/docs/reference/annotations.md index 41bdc2525..ebe6b05b3 100644 --- a/docs/reference/annotations.md +++ b/docs/reference/annotations.md @@ -49,12 +49,12 @@ referenced from properties outside the components object. ---
callbacks : array
-

Reusable Callbacks.

Required:no
+

Reusable Callbacks.

Required:no
#### Reference --- -- [OAI Components Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object) +- [Components Object](https://spec.openapis.org/oas/v3.1.1.html#components-object) ### [Contact](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Contact.php) @@ -72,16 +72,16 @@ Contact information for the exposed API. ---
name : string
-

The identifying name of the contact person/organization.

Required:no
+

The identifying name of the contact person/organization.

Required:no
url : string
-

The URL pointing to the contact information.

Required:no
+

The URL pointing to the contact information.

Required:no
email : string
-

The email address of the contact person/organization.

Required:no
+

The email address of the contact person/organization.

Required:no
#### Reference --- -- [OAI Contact Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object) +- [Contact Object](https://spec.openapis.org/oas/v3.1.1.html#components-object) ### [CookieParameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/CookieParameter.php) @@ -99,7 +99,7 @@ A `@OA\Request` cookie parameter. ---
in
-

This takes 'cookie' as the default location.

Required:yes
+

This takes 'cookie' as the default location.

Required:yes
### [Delete](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Delete.php) @@ -118,7 +118,7 @@ A `@OA\Request` cookie parameter. ---
method
-

No details available.

Required:no
+

No details available.

Required:no
### [Discriminator](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Discriminator.php) @@ -141,14 +141,14 @@ On top of this subset, there are extensions provided by this specification to al ---
propertyName : string
-

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

Required:yes
+

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:no
+

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

Required:no
#### Reference --- -- [OAI Discriminator Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminatorObject) +- [Discriminator Object](https://spec.openapis.org/oas/v3.1.1.html#discriminator-object) - [JSON Schema](http://json-schema.org/) ### [Examples](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Examples.php) @@ -167,32 +167,32 @@ On top of this subset, there are extensions provided by this specification to al ---
ref : string|class-string|object
-

The relative or absolute path to an example.

Required:no
See:Using refs
+

The relative or absolute path to an example.

Required:no
See:Reference Object
example : string
-

The key into `#/components/examples`.

Required:no
+

The key into `#/components/examples`.

Required:no
summary : string
-

Short description for the example.

Required:yes
+

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:no
+in JSON or YAML, use a string value to contain the example, escaping where necessary.

Required:no
value : int|string|array

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:no
+in JSON or YAML, use a string value to contain the example, escaping where necessary.

Required:no
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:no
+The value field and externalValue field are mutually exclusive.

Required:no
### [ExternalDocumentation](https://github.com/zircote/swagger-php/tree/master/src/Annotations/ExternalDocumentation.php) @@ -211,18 +211,18 @@ Allows referencing an external resource for extended documentation. ---
description : string
-

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

Required:no
+

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

Required:no
url : string
-

The URL for the target documentation.

Required:yes
+

The URL for the target documentation.

Required:yes
#### Reference --- -- [OAI External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#external-documentation-object) +- [External Documentation Object](https://spec.openapis.org/oas/v3.1.1.html#external-documentation-object) ### [Flow](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Flow.php) -Configuration details for a supported OAuth Flow. +Configuration details for a supported OAuth flow. #### Allowed in --- @@ -238,28 +238,28 @@ Configuration details for a supported OAuth Flow.
authorizationUrl : string

The authorization url to be used for this flow.

-This must be in the form of an url.

Required:no
+This must be in the form of an url.

Required:no
tokenUrl : string

The token URL to be used for this flow.

-This must be in the form of an url.

Required:no
+This must be in the form of an url.

Required:no
refreshUrl : string

The URL to be used for obtaining refresh tokens.

-This must be in the form of an url.

Required:no
+This must be in the form of an url.

Required:no
flow : string

Flow name.

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

Required:yes
+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
+A map between the scope name and a short description for it.

Required:yes
#### Reference --- -- [OAI OAuth Flow Object](https://swagger.io/specification/#oauthFlowObject) +- [OAuth Flow Object](https://spec.openapis.org/oas/v3.1.1.html#oauth-flow-object) ### [Get](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Get.php) @@ -277,7 +277,7 @@ A map between the scope name and a short description for it.

Required:no
+

No details available.

Required:no
### [Head](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Head.php) @@ -296,7 +296,7 @@ A map between the scope name and a short description for it.

Required:no
+

No details available.

Required:no
### [Header](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Header.php) @@ -315,18 +315,18 @@ A map between the scope name and a short description for it.

string|class-string|object -

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
header : string
-

No details available.

Required:yes
+

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:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
required : bool
-

No details available.

Required:no
+

No details available.

Required:no
deprecated : bool
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool

Sets the ability to pass empty-valued parameters.

@@ -334,12 +334,12 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.

Required:no
#### Reference --- -- [OAI Header Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject). +- [Header Object](https://spec.openapis.org/oas/v3.1.1.html#header-object) ### [HeaderParameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/HeaderParameter.php) @@ -357,7 +357,7 @@ A `@OA\Request` header parameter. ---
in
-

This takes 'header' as the default location.

Required:yes
+

This takes 'header' as the default location.

Required:yes
### [Info](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Info.php) @@ -378,22 +378,22 @@ The metadata may be used by the clients if needed and may be presented in editin ---
title : string
-

The title of the application.

Required:yes
+

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:no
+CommonMark syntax may be used for rich text representation.

Required:no
termsOfService : string

An URL to the Terms of Service for the API.

-Must be in the format of an url.

Required:no
+Must be in the format of an url.

Required:no
version : string
-

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

Required:yes
+

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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object) +- [Info Object](https://spec.openapis.org/oas/v3.1.1.html#info-object) ### [Items](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Items.php) @@ -433,18 +433,18 @@ License information for the exposed API. ---
name : string
-

The license name used for the API.

Required:yes
+

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:no
+

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

Required:no
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:no
+The `url` field is mutually exclusive of the `identifier` field.

Required:no
#### Reference --- -- [OAI License Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object) +- [License Object](https://spec.openapis.org/oas/v3.1.1.html#license-object) ### [Link](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Link.php) @@ -471,19 +471,19 @@ accessing values in an operation and using them as parameters while invoking the ---
ref : string|class-string|object
-

No details available.

Required:no
See:Using refs
+

No details available.

Required:no
See:Reference Object
link : string
-

The key into MediaType->links array.

Required:no
+

The key into MediaType->links array.

Required:no
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:no
+Relative values may be used to locate an existing Operation object in the OpenAPI definition.

Required:no
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:no
+This field is mutually exclusive of the operationRef field.

Required:no
parameters : array<string,mixed>

A map representing parameters to pass to an operation as specified with operationId or identified via
operationRef.
@@ -491,18 +491,18 @@ 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:no
+that use the same parameter name in different locations (e.g. path.id).

Required:no
requestBody
-

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

Required:no
+

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

Required:no
description : string

A description of the link.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
#### Reference --- -- [OAI Link Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object) +- [Link Object](https://spec.openapis.org/oas/v3.1.1.html#link-object) ### [MediaType](https://github.com/zircote/swagger-php/tree/master/src/Annotations/MediaType.php) @@ -520,7 +520,7 @@ Each Media Type object provides schema and examples for the media type identifie ---
mediaType : string
-

The key into Operation->content array.

Required:no
+

The key into Operation->content array.

Required:no
example

Example of the media type.

@@ -528,19 +528,19 @@ The example object should be in the correct format as specified by the media typ 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:no
+the example value shall override the example provided by the schema.

Required:no
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:no
+application/x-www-form-urlencoded.

Required:no
#### Reference --- -- [OAI Media Type Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object) +- [Media Type Object](https://spec.openapis.org/oas/v3.1.1.html#media-type-object) ### [OpenApi](https://github.com/zircote/swagger-php/tree/master/src/Annotations/OpenApi.php) @@ -560,19 +560,19 @@ The openapi field should be used by tooling specifications and clients to interp
A version specified via `Generator::setVersion()` will overwrite this value.

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

Required:yes
+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:no
+To make security optional, an empty security requirement `({})` can be included in the array.

Required:no
#### Reference --- -- [OAI OpenApi Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#openapi-object) +- [OpenApi Object](https://spec.openapis.org/oas/v3.1.1.html#openapi-object) ### [Options](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Options.php) @@ -590,7 +590,7 @@ To make security optional, an empty security requirement `({})` can be included ---
method
-

No details available.

Required:no
+

No details available.

Required:no
### [Parameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Parameter.php) @@ -611,33 +611,33 @@ A unique parameter is defined by a combination of a name and location. ---
ref : string|class-string|object
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
parameter : string
-

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

Required:no
+

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

Required:no
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
+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
+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:no
+CommonMark syntax may be used for rich text representation.

Required:no
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:no
+Otherwise, the property may be included and its default value is false.

Required:no
deprecated : bool
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool

Sets the ability to pass empty-valued parameters.

@@ -645,63 +645,63 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.

Required:no
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:no
+Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Required:no
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:no
+For all other styles, the default value is false.

Required:no
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:no
+The default value is false.

Required:no
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:no
+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:no
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:no
+The map must only contain one entry.

Required:no
matrix
-

Path-style parameters defined by RFC6570.

Required:no
See:RFC6570
+

Path-style parameters defined by RFC6570.

Required:no
See:RFC6570
label
-

Label style parameters defined by RFC6570.

Required:no
See:RFC6570
+

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
+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
+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:no
+This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
pipeDelimited : array

Pipe separated array values.

-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
deepObject
-

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

Required:no
+

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

Required:no
#### Reference --- -- [OAA Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object) +- [Parameter Object](https://spec.openapis.org/oas/v3.1.1.html#parameter-object) ### [Patch](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Patch.php) @@ -719,7 +719,7 @@ This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

method
-

No details available.

Required:no
+

No details available.

Required:no
### [PathItem](https://github.com/zircote/swagger-php/tree/master/src/Annotations/PathItem.php) @@ -741,18 +741,18 @@ The path itself is still exposed to the documentation viewer, but they will not ---
ref : string|class-string|object
-

No details available.

Required:no
See:Using refs
+

No details available.

Required:no
See:Reference Object
summary : string
-

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

Required:no
+

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

Required:no
description : string
-

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

Required:no
+

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

Required:no
path : string
-

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

Required:no
+

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

Required:no
#### Reference --- -- [OAI Path Item Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object) +- [Path Item Object](https://spec.openapis.org/oas/v3.1.1.html#path-item-object) ### [PathParameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/PathParameter.php) @@ -770,9 +770,9 @@ A `@OA\Request` path parameter. ---
in
-

This takes 'path' as the default location.

Required:no
+

This takes 'path' as the default location.

Required:no
required
-

No details available.

Required:no
+

No details available.

Required:no
### [Post](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Post.php) @@ -791,7 +791,7 @@ A `@OA\Request` path parameter. ---
method
-

No details available.

Required:no
+

No details available.

Required:no
### [Property](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Property.php) @@ -810,7 +810,7 @@ A `@OA\Request` path parameter. ---
property : string
-

The key into Schema->properties array.

Required:no
+

The key into Schema->properties array.

Required:no
### [Put](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Put.php) @@ -829,7 +829,7 @@ A `@OA\Request` path parameter. ---
method
-

No details available.

Required:no
+

No details available.

Required:no
### [QueryParameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/QueryParameter.php) @@ -848,7 +848,7 @@ A `@OA\Request` query parameter. ---
in
-

This takes 'query' as the default location.

Required:yes
+

This takes 'query' as the default location.

Required:yes
### [RequestBody](https://github.com/zircote/swagger-php/tree/master/src/Annotations/RequestBody.php) @@ -867,25 +867,25 @@ Describes a single request body. ---
ref : string|class-string|object
-

The relative or absolute path to a request body.

Required:no
See:Using refs
+

The relative or absolute path to a request body.

Required:no
See:Reference Object
request : string
-

The key into Components->requestBodies array.

Required:no
+

The key into Components->requestBodies array.

Required:no
description : string

A brief description of the parameter.

This could contain examples of use.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
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:no
+Otherwise, the property may be included and its default value is false.

Required:no
#### Reference --- -- [OAI Request Body Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#requestBodyObject) +- [Request Body Object](https://spec.openapis.org/oas/v3.1.1.html#request-body-object) ### [Response](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Response.php) @@ -904,20 +904,20 @@ static links to operations based on the response. ---
ref : string|class-string|object
-

The relative or absolute path to a response.

Required:no
See:Using refs
+

The relative or absolute path to a response.

Required:no
See:Reference Object
response : string|int

The key into Operations->responses array.

-A HTTP status code or default.

Required:no
+A HTTP status code or default.

Required:no
description : string

A short description of the response.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
#### Reference --- -- [OAI Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object) +- [Response Object](https://spec.openapis.org/oas/v3.1.1.html#response-object) ### [Schema](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Schema.php) @@ -940,34 +940,34 @@ On top of this subset, there are extensions provided by this specification to al ---
ref : string|class-string|object
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : string
-

The key into Components->schemas array.

Required:no
+

The key into Components->schemas array.

Required:no
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:no
+Preferably short; use description for more details.

Required:no
description : string
-

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

Required:no
+

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

Required:no
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:no
+value of this attribute.

Required:no
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:no
+value of this attribute.

Required:no
required : string[]

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

Required:no
+array value.

Required:no
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:no
+Since OpenApi v3.1 an array of types may be used.

Required:no
format : string
-

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

Required:no
+

The extending format for the previously mentioned type.

Required:no
See:Data Types
collectionFormat : string

Determines the format of the array if type array is used.

@@ -978,55 +978,55 @@ Possible values are:
- 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:no
+value is csv.

Required:no
default
-

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

Required:no
See:JSON schema validation
+

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
+

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

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
+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
+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
+attribute.

Required:no
See:JSON schema validation
pattern : string
-

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

Required:no
+

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

Required:no
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
+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
+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
+If this attribute is set to true, then all items in the array must be unique.

Required:no
See:JSON schema validation
enum : array<string|int|float|bool|\UnitEnum>|class-string

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
+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:no
+property's value is an integer.

Required:no
readOnly : bool

Declares the property as "read only".

@@ -1035,7 +1035,7 @@ 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:no
+false.

Required:no
writeOnly : bool

Declares the property as "write only".

@@ -1043,49 +1043,49 @@ 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:no
+false.

Required:no
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:no
+contain the example with escaping where necessary.

Required:no
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:no
+instead make the "type" property an array and add "null" as a possible type.

Required:no
deprecated : bool

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

Required:no
+Default value is false.

Required:no
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:no
+defined by this property's value.

Required:no
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:no
+schema defined by this property's value.

Required:no
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:no
+defined by this property's value.

Required:no
not
-

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

Required:no
+

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

Required:no
additionalItems
-

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

Required:no
+

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

Required:no
contains
-

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

Required:no
+

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

Required:no
patternProperties
-

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

Required:no
+

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

Required:no
dependencies
-

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

Required:no
+

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

Required:no
propertyNames
-

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

Required:no
+

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

Required:no
const
-

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

Required:no
+

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

Required:no
#### Reference --- -- [OAI Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject) +- [Schema Object](https://spec.openapis.org/oas/v3.1.1.html#schema-object) - [JSON Schema](http://json-schema.org/) ### [SecurityScheme](https://github.com/zircote/swagger-php/tree/master/src/Annotations/SecurityScheme.php) @@ -1104,30 +1104,30 @@ defined by this property's value.

Requi ---
ref : string|class-string|object
-

The relative or absolute path to a security scheme.

Required:no
See:Using refs
+

The relative or absolute path to a security scheme.

Required:no
See:Reference Object
securityScheme : string
-

The key into OpenApi->security array.

Required:yes
+

The key into OpenApi->security array.

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

The type of the security scheme.

Required:yes
+

The type of the security scheme.

Required:yes
description : string
-

A short description for security scheme.

Required:no
+

A short description for security scheme.

Required:no
name : string
-

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

Required:no
+

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

Required:no
in : string
-

Required The location of the API key.

Required:no
+

Required The location of the API key.

Required:no
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:no
+Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.

Required:no
scheme : string
-

The name of the HTTP Authorization scheme.

Required:no
See:RFC7235
+

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:no
+

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

Required:no
#### Reference --- -- [OAI Security Scheme Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject). +- [Security Scheme Object](https://spec.openapis.org/oas/v3.1.1.html#security-scheme-object-0) ### [Server](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Server.php) @@ -1149,16 +1149,16 @@ An object representing a server.
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
+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:no
+CommonMark syntax may be used for rich text representation.

Required:no
#### Reference --- -- [OAI Server Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object) +- [Server Object](https://spec.openapis.org/oas/v3.1.1.html#server-object) ### [ServerVariable](https://github.com/zircote/swagger-php/tree/master/src/Annotations/ServerVariable.php) @@ -1176,26 +1176,26 @@ An object representing a server variable for server URL template substitution. ---
serverVariable : string
-

The key into Server->variables array.

Required:no
+

The key into Server->variables array.

Required:no
enum : array<string|int|float|bool|\UnitEnum>|class-string
-

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

Required:no
+

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

Required:no
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
+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:no
+The value is used for substitution in the server's URL template.

Required:no
description : string

An optional description for the server variable.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
#### Reference --- -- [OAI Server Variable Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object) +- [Server Variable Object](https://spec.openapis.org/oas/v3.1.1.html#server-variable-object) ### [Tag](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Tag.php) @@ -1213,14 +1213,14 @@ CommonMark syntax MAY be used for rich text representation.

string -

The name of the tag.

Required:yes
+

The name of the tag.

Required:yes
description : string
-

A short description for the tag. GFM syntax can be used for rich text representation.

Required:no
+

A short description for the tag. GFM syntax can be used for rich text representation.

Required:no
#### Reference --- -- [OAI Tag Object]( https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#tagObject). +- [Tag Object](https://spec.openapis.org/oas/v3.1.1.html#tag-object) ### [Trace](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Trace.php) @@ -1238,7 +1238,7 @@ CommonMark syntax MAY be used for rich text representation.

Required:no
+

No details available.

Required:no
### [Webhook](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Webhook.php) @@ -1257,7 +1257,7 @@ Acts like a `PathItem` with the main difference being that it requires `webhook` ---
webhook : string
-

Key for the webhooks map.

Required:yes
+

Key for the webhooks map.

Required:yes
### [Xml](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Xml.php) @@ -1282,27 +1282,27 @@ When defined within the Items Object (items), it will affect the name of the ind 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.

Required:no
+If wrapped is false, it will be ignored.

Required:no
namespace : string
-

The URL of the namespace definition. Value SHOULD be in the form of a URL.

Required:no
+

The URL of the namespace definition. Value SHOULD be in the form of a URL.

Required:no
prefix : string
-

The prefix to be used for the name.

Required:no
+

The prefix to be used for the name.

Required:no
attribute : bool

Declares whether the property definition translates to an attribute instead of an element.

-Default value is false.

Required:no
+Default value is false.

Required:no
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).

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

Required:no
#### Reference --- -- [OAI XML Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#xmlObject). +- [XML Object](https://spec.openapis.org/oas/v3.1.1.html#xml-object) ### [XmlContent](https://github.com/zircote/swagger-php/tree/master/src/Annotations/XmlContent.php) diff --git a/docs/reference/attributes.md b/docs/reference/attributes.md index b6b28be53..7bd1f5ba9 100644 --- a/docs/reference/attributes.md +++ b/docs/reference/attributes.md @@ -24,40 +24,40 @@ In addition to this page, there are also a number of [examples](https://github.c ---
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : string|null
-

The key into Components->schemas array.

Required:no
+

The key into Components->schemas array.

Required:no
title : string|null

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:no
+Preferably short; use description for more details.

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
maxProperties : int|null

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:no
+value of this attribute.

Required:no
minProperties : int|null

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:no
+value of this attribute.

Required:no
required : string[]

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

Required:no
+array value.

Required:no
properties : Property[]

A collection of properties to define for an object.

-Each property is represented as an instance of the Property class.

Required:no
+Each property is represented as an instance of the Property class.

Required:no
type : string|non-empty-array<string>|null

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:no
+Since OpenApi v3.1 an array of types may be used.

Required:no
format : string|null
-

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

Required:no
+

The extending format for the previously mentioned type.

Required:no
See:Data Types
items : OpenApi\Attributes\Items|null
-

Required if type is "array". Describes the type of items in the array.

Required:no
+

Required if type is "array". Describes the type of items in the array.

Required:no
collectionFormat : string|null

Determines the format of the array if type array is used.

@@ -68,57 +68,57 @@ Possible values are:
- 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:no
+value is csv.

Required:no
default : mixed|null
-

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

Required:no
See:JSON schema validation
+

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
+

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

Required:no
See:JSON schema validation
exclusiveMaximum : int|float|bool|null

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

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

Required:no
See:JSON schema validation
exclusiveMinimum : int|float|bool|null

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

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
+attribute.

Required:no
See:JSON schema validation
minLength : int|null

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
+attribute.

Required:no
See:JSON schema validation
maxItems : int|null

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
+this attribute.

Required:no
See:JSON schema validation
minItems : int|null

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
+of this attribute.

Required:no
See:JSON schema validation
uniqueItems : bool|null

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
+If this attribute is set to true, then all items in the array must be unique.

Required:no
See:JSON schema validation
pattern : string|null
-

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

Required:no
+

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

Required:no
enum : array<string|int|float|bool|\UnitEnum|null>|class-string|null

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
+collection.

Required:no
See:JSON schema validation
discriminator : OpenApi\Attributes\Discriminator|null

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.

Required:no
+payload description. See Composition and Inheritance for more details.

Required:no
readOnly : bool|null

Declares the property as "read only".

@@ -127,7 +127,7 @@ 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:no
+false.

Required:no
writeOnly : bool|null

Declares the property as "write only".

@@ -135,46 +135,46 @@ 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:no
+false.

Required:no
xml : OpenApi\Attributes\Xml|null

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.

Required:no
+Adds additional metadata to describe the XML representation of this property.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this schema.

Required:no
+

Additional external documentation for this schema.

Required:no
example : mixed|null

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:no
+contain the example with escaping where necessary.

Required:no
nullable : bool|null

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:no
+instead make the "type" property an array and add "null" as a possible type.

Required:no
deprecated : bool|null

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

Required:no
+Default value is false.

Required:no
allOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
anyOf : array<Schema|OA\Schema>

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

Required:no
+schema defined by this property's value.

Required:no
oneOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
-

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
+

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Attachable](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Attachable.php) @@ -189,7 +189,7 @@ These will be ignored but can be used for custom processing.

array -

No details available.

Required:no
+

No details available.

Required:no
### [Components](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Components.php) @@ -208,30 +208,30 @@ These will be ignored but can be used for custom processing.

array<Schema|OA\Schema>|null -

Reusable Schemas.

Required:no
+

Reusable Schemas.

Required:no
responses : Response[]|null
-

Reusable Responses.

Required:no
+

Reusable Responses.

Required:no
parameters : Parameter[]|null
-

Reusable Parameters.

Required:no
+

Reusable Parameters.

Required:no
requestBodies : RequestBody[]|null
-

Reusable Request Bodies.

Required:no
+

Reusable Request Bodies.

Required:no
examples : array<Examples>|null
-

Reusable Examples.

Required:no
+

Reusable Examples.

Required:no
headers : Header[]|null
-

Reusable Headers.

Required:no
+

Reusable Headers.

Required:no
securitySchemes : SecurityScheme[]|null
-

Reusable Security Schemes.

Required:no
+

Reusable Security Schemes.

Required:no
links : Link[]|null
-

Reusable Links.

Required:no
+

Reusable Links.

Required:no
callbacks : array|null
-

Reusable Callbacks.

Required:no
+

Reusable Callbacks.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Contact](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Contact.php) @@ -250,18 +250,18 @@ These will be ignored but can be used for custom processing.

string|null -

The identifying name of the contact person/organization.

Required:no
+

The identifying name of the contact person/organization.

Required:no
url : string|null
-

The URL pointing to the contact information.

Required:no
+

The URL pointing to the contact information.

Required:no
email : string|null
-

The email address of the contact person/organization.

Required:no
+

The email address of the contact person/organization.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [CookieParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/CookieParameter.php) @@ -280,29 +280,29 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:no
+

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

Required:no
name : string|null

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
+For all other cases, the name corresponds to the parameter name used by the in property.

Required:yes
description : string|null

A brief description of the parameter.

This could contain examples of use.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
in : string|null
-

This takes 'cookie' as the default location.

Required:yes
+

This takes 'cookie' as the default location.

Required:yes
required : bool|null

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:no
+Otherwise, the property may be included and its default value is false.

Required:no
deprecated : bool|null
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool|null

Sets the ability to pass empty-valued parameters.

@@ -310,61 +310,61 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : OpenApi\Attributes\Schema|null
-

The schema defining the type used for the parameter.

Required:no
+

The schema defining the type used for the parameter.

Required:no
example : mixed|null

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:no
+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:no
examples : array<Examples>

Examples of the parameter.

Each example should contain a value in the correct format as specified in the parameter encoding.
The examples object is mutually exclusive of the example object.
-Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
content : array<MediaType>|JsonContent|XmlContent|Attachable|null

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:no
+The map must only contain one entry.

Required:no
style : string|null

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:no
+Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Required:no
explode : bool|null

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:no
+For all other styles, the default value is false.

Required:no
allowReserved : bool|null

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:no
+The default value is false.

Required:no
spaceDelimited : array|null

Space separated array values.

-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
pipeDelimited : array|null

Pipe separated array values.

-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Delete](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Delete.php) @@ -383,19 +383,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -404,22 +404,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -429,9 +429,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -439,22 +439,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Discriminator](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Discriminator.php) @@ -473,16 +473,16 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:yes
+

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

Required:yes
mapping : string[]|null
-

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

Required:no
+

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

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Examples](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Examples.php) @@ -501,39 +501,39 @@ These will be ignored but can be used for custom processing.

string|null -

The key into `#/components/examples`.

Required:no
+

The key into `#/components/examples`.

Required:no
summary : string|null
-

Short description for the example.

Required:yes
+

Short description for the example.

Required:yes
description : string|null

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:no
+in JSON or YAML, use a string value to contain the example, escaping where necessary.

Required:no
value : array|string|int|null

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:no
+in JSON or YAML, use a string value to contain the example, escaping where necessary.

Required:no
externalValue : string|null

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:no
+The value field and externalValue field are mutually exclusive.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to an example.

Required:no
See:Using refs
+

The relative or absolute path to an example.

Required:no
See:Reference Object
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [ExternalDocumentation](https://github.com/zircote/swagger-php/tree/master/src/Attributes/ExternalDocumentation.php) @@ -552,16 +552,16 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:no
+

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

Required:no
url : string|null
-

The URL for the target documentation.

Required:yes
+

The URL for the target documentation.

Required:yes
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Flow](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Flow.php) @@ -582,30 +582,30 @@ These will be ignored but can be used for custom processing.

string|null

The authorization url to be used for this flow.

-This must be in the form of an url.

Required:no
+This must be in the form of an url.

Required:no
tokenUrl : string|null

The token URL to be used for this flow.

-This must be in the form of an url.

Required:no
+This must be in the form of an url.

Required:no
refreshUrl : string|null

The URL to be used for obtaining refresh tokens.

-This must be in the form of an url.

Required:no
+This must be in the form of an url.

Required:no
flow : string|null

Flow name.

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

Required:yes
+One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].

Required:yes
scopes : array|null

The available scopes for the OAuth2 security scheme.

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

Required:yes
+A map between the scope name and a short description for it.

Required:yes
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Get](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Get.php) @@ -624,19 +624,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -645,22 +645,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -670,9 +670,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -680,22 +680,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Head](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Head.php) @@ -714,19 +714,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -735,22 +735,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -760,9 +760,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -770,22 +770,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Header](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Header.php) @@ -804,20 +804,20 @@ These will be ignored but can be used for custom processing.

string|class-string|object|null -

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
header : string|null
-

No details available.

Required:yes
+

No details available.

Required:yes
description : string|null

A brief description of the parameter.

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

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
required : bool|null
-

No details available.

Required:no
+

No details available.

Required:no
schema : OpenApi\Attributes\Schema|null
-

Schema object.

Required:yes
+

Schema object.

Required:yes
deprecated : bool|null
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool|null

Sets the ability to pass empty-valued parameters.

@@ -825,14 +825,14 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [HeaderParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/HeaderParameter.php) @@ -851,29 +851,29 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:no
+

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

Required:no
name : string|null

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
+For all other cases, the name corresponds to the parameter name used by the in property.

Required:yes
description : string|null

A brief description of the parameter.

This could contain examples of use.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
in : string|null
-

This takes 'header' as the default location.

Required:yes
+

This takes 'header' as the default location.

Required:yes
required : bool|null

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:no
+Otherwise, the property may be included and its default value is false.

Required:no
deprecated : bool|null
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool|null

Sets the ability to pass empty-valued parameters.

@@ -881,61 +881,61 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : OpenApi\Attributes\Schema|null
-

The schema defining the type used for the parameter.

Required:no
+

The schema defining the type used for the parameter.

Required:no
example : mixed|null

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:no
+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:no
examples : array<Examples>

Examples of the parameter.

Each example should contain a value in the correct format as specified in the parameter encoding.
The examples object is mutually exclusive of the example object.
-Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
content : array<MediaType>|JsonContent|XmlContent|Attachable|null

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:no
+The map must only contain one entry.

Required:no
style : string|null

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:no
+Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Required:no
explode : bool|null

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:no
+For all other styles, the default value is false.

Required:no
allowReserved : bool|null

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:no
+The default value is false.

Required:no
spaceDelimited : array|null

Space separated array values.

-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
pipeDelimited : array|null

Pipe separated array values.

-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Info](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Info.php) @@ -954,28 +954,28 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:yes
+

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

Required:yes
description : string|null

A short description of the application.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
title : string|null
-

The title of the application.

Required:yes
+

The title of the application.

Required:yes
termsOfService : string|null

An URL to the Terms of Service for the API.

-Must be in the format of an url.

Required:no
+Must be in the format of an url.

Required:no
contact : OpenApi\Attributes\Contact|null
-

The contact information for the exposed API.

Required:no
+

The contact information for the exposed API.

Required:no
license : OpenApi\Attributes\License|null
-

The license information for the exposed API.

Required:no
+

The license information for the exposed API.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Items](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Items.php) @@ -994,40 +994,40 @@ These will be ignored but can be used for custom processing.

string|class-string|object|null -

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : string|null
-

The key into Components->schemas array.

Required:no
+

The key into Components->schemas array.

Required:no
title : string|null

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:no
+Preferably short; use description for more details.

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
maxProperties : int|null

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:no
+value of this attribute.

Required:no
minProperties : int|null

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:no
+value of this attribute.

Required:no
required : string[]

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

Required:no
+array value.

Required:no
properties : Property[]

A collection of properties to define for an object.

-Each property is represented as an instance of the Property class.

Required:no
+Each property is represented as an instance of the Property class.

Required:no
type : string|non-empty-array<string>|null

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:no
+Since OpenApi v3.1 an array of types may be used.

Required:no
format : string|null
-

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

Required:no
+

The extending format for the previously mentioned type.

Required:no
See:Data Types
items : OpenApi\Attributes\Items|null
-

Required if type is "array". Describes the type of items in the array.

Required:no
+

Required if type is "array". Describes the type of items in the array.

Required:no
collectionFormat : string|null

Determines the format of the array if type array is used.

@@ -1038,57 +1038,57 @@ Possible values are:
- 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:no
+value is csv.

Required:no
default : mixed|null
-

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

Required:no
See:JSON schema validation
+

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
+

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

Required:no
See:JSON schema validation
exclusiveMaximum : int|float|bool|null

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

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

Required:no
See:JSON schema validation
exclusiveMinimum : int|float|bool|null

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

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
+attribute.

Required:no
See:JSON schema validation
minLength : int|null

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
+attribute.

Required:no
See:JSON schema validation
maxItems : int|null

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
+this attribute.

Required:no
See:JSON schema validation
minItems : int|null

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
+of this attribute.

Required:no
See:JSON schema validation
uniqueItems : bool|null

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
+If this attribute is set to true, then all items in the array must be unique.

Required:no
See:JSON schema validation
pattern : string|null
-

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

Required:no
+

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

Required:no
enum : array<string|int|float|bool|\UnitEnum|null>|class-string|null

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
+collection.

Required:no
See:JSON schema validation
discriminator : OpenApi\Attributes\Discriminator|null

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.

Required:no
+payload description. See Composition and Inheritance for more details.

Required:no
readOnly : bool|null

Declares the property as "read only".

@@ -1097,7 +1097,7 @@ 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:no
+false.

Required:no
writeOnly : bool|null

Declares the property as "write only".

@@ -1105,46 +1105,46 @@ 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:no
+false.

Required:no
xml : OpenApi\Attributes\Xml|null

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.

Required:no
+Adds additional metadata to describe the XML representation of this property.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this schema.

Required:no
+

Additional external documentation for this schema.

Required:no
example : mixed|null

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:no
+contain the example with escaping where necessary.

Required:no
nullable : bool|null

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:no
+instead make the "type" property an array and add "null" as a possible type.

Required:no
deprecated : bool|null

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

Required:no
+Default value is false.

Required:no
allOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
anyOf : array<Schema|OA\Schema>

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

Required:no
+schema defined by this property's value.

Required:no
oneOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
-

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
+

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [JsonContent](https://github.com/zircote/swagger-php/tree/master/src/Attributes/JsonContent.php) @@ -1163,42 +1163,42 @@ These will be ignored but can be used for custom processing.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : string|null
-

The key into Components->schemas array.

Required:no
+

The key into Components->schemas array.

Required:no
title : string|null

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:no
+Preferably short; use description for more details.

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
maxProperties : int|null

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:no
+value of this attribute.

Required:no
minProperties : int|null

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:no
+value of this attribute.

Required:no
required : string[]

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

Required:no
+array value.

Required:no
properties : Property[]

A collection of properties to define for an object.

-Each property is represented as an instance of the Property class.

Required:no
+Each property is represented as an instance of the Property class.

Required:no
type : string|non-empty-array<string>|null

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:no
+Since OpenApi v3.1 an array of types may be used.

Required:no
format : string|null
-

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

Required:no
+

The extending format for the previously mentioned type.

Required:no
See:Data Types
items : OpenApi\Attributes\Items|null
-

Required if type is "array". Describes the type of items in the array.

Required:no
+

Required if type is "array". Describes the type of items in the array.

Required:no
collectionFormat : string|null

Determines the format of the array if type array is used.

@@ -1209,57 +1209,57 @@ Possible values are:
- 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:no
+value is csv.

Required:no
default : mixed|null
-

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

Required:no
See:JSON schema validation
+

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
+

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

Required:no
See:JSON schema validation
exclusiveMaximum : int|float|bool|null

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

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

Required:no
See:JSON schema validation
exclusiveMinimum : int|float|bool|null

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

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
+attribute.

Required:no
See:JSON schema validation
minLength : int|null

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
+attribute.

Required:no
See:JSON schema validation
maxItems : int|null

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
+this attribute.

Required:no
See:JSON schema validation
minItems : int|null

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
+of this attribute.

Required:no
See:JSON schema validation
uniqueItems : bool|null

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
+If this attribute is set to true, then all items in the array must be unique.

Required:no
See:JSON schema validation
pattern : string|null
-

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

Required:no
+

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

Required:no
enum : array<string|int|float|bool|\UnitEnum|null>|class-string|null

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
+collection.

Required:no
See:JSON schema validation
discriminator : OpenApi\Attributes\Discriminator|null

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.

Required:no
+payload description. See Composition and Inheritance for more details.

Required:no
readOnly : bool|null

Declares the property as "read only".

@@ -1268,7 +1268,7 @@ 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:no
+false.

Required:no
writeOnly : bool|null

Declares the property as "write only".

@@ -1276,46 +1276,46 @@ 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:no
+false.

Required:no
xml : OpenApi\Attributes\Xml|null

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.

Required:no
+Adds additional metadata to describe the XML representation of this property.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this schema.

Required:no
+

Additional external documentation for this schema.

Required:no
example : mixed|null

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:no
+contain the example with escaping where necessary.

Required:no
nullable : bool|null

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:no
+instead make the "type" property an array and add "null" as a possible type.

Required:no
deprecated : bool|null

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

Required:no
+Default value is false.

Required:no
allOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
anyOf : array<Schema|OA\Schema>

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

Required:no
+schema defined by this property's value.

Required:no
oneOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
-

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
+

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [License](https://github.com/zircote/swagger-php/tree/master/src/Attributes/License.php) @@ -1334,20 +1334,20 @@ These will be ignored but can be used for custom processing.

string|null -

The license name used for the API.

Required:yes
+

The license name used for the API.

Required:yes
identifier : string|null
-

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

Required:no
+

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

Required:no
url : string|null

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:no
+The `url` field is mutually exclusive of the `identifier` field.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Link](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Link.php) @@ -1366,19 +1366,19 @@ These will be ignored but can be used for custom processing.

string|null -

The key into MediaType->links array.

Required:no
+

The key into MediaType->links array.

Required:no
operationRef : string|null

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:no
+Relative values may be used to locate an existing Operation object in the OpenAPI definition.

Required:no
ref : string|class-string|object|null
-

No details available.

Required:no
See:Using refs
+

No details available.

Required:no
See:Reference Object
operationId : string|null

The name of an existing, resolvable OA operation, as defined with a unique operationId.

-This field is mutually exclusive of the operationRef field.

Required:no
+This field is mutually exclusive of the operationRef field.

Required:no
parameters : array<string,mixed>

A map representing parameters to pass to an operation as specified with operationId or identified via
operationRef.
@@ -1386,22 +1386,22 @@ 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:no
+that use the same parameter name in different locations (e.g. path.id).

Required:no
requestBody : mixed|null
-

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

Required:no
+

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

Required:no
description : string|null

A description of the link.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
server : OpenApi\Attributes\Server|null
-

A server object to be used by the target operation.

Required:no
+

A server object to be used by the target operation.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [MediaType](https://github.com/zircote/swagger-php/tree/master/src/Attributes/MediaType.php) @@ -1420,9 +1420,9 @@ These will be ignored but can be used for custom processing.

string|null -

The key into Operation->content array.

Required:no
+

The key into Operation->content array.

Required:no
schema : OpenApi\Attributes\Schema|null
-

The schema defining the type used for the request body.

Required:no
+

The schema defining the type used for the request body.

Required:no
example : mixed|null

Example of the media type.

@@ -1430,27 +1430,27 @@ The example object should be in the correct format as specified by the media typ 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:no
+the example value shall override the example provided by the schema.

Required:no
examples : array<Examples>

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.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
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:no
+application/x-www-form-urlencoded.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [OpenApi](https://github.com/zircote/swagger-php/tree/master/src/Attributes/OpenApi.php) @@ -1471,42 +1471,42 @@ The openapi field should be used by tooling specifications and clients to interp
A version specified via `Generator::setVersion()` will overwrite this value.

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

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

Required:yes
info : OpenApi\Attributes\Info|null
-

Provides metadata about the API. The metadata may be used by tooling as required.

Required:yes
+

Provides metadata about the API. The metadata may be used by tooling as required.

Required:yes
servers : Server[]|null

An array of @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 an url value of /.

Required:no
+If not provided, or is an empty array, the default value would be a Server Object with an url value of /.

Required:no
security : array|null

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:no
+To make security optional, an empty security requirement `({})` can be included in the array.

Required:no
tags : Tag[]|null

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.

Required:no
+Each tag name in the list must be unique.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation.

Required:no
+

Additional external documentation.

Required:no
paths : PathItem[]|null
-

The available paths and operations for the API.

Required:no
+

The available paths and operations for the API.

Required:no
components : OpenApi\Attributes\Components|null
-

An element to hold various components for the specification.

Required:no
+

An element to hold various components for the specification.

Required:no
webhooks : Webhook[]|null
-

The available webhooks for the API.

Required:no
+

The available webhooks for the API.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Options](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Options.php) @@ -1525,19 +1525,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -1546,22 +1546,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -1571,9 +1571,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -1581,22 +1581,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Parameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Parameter.php) @@ -1615,31 +1615,31 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:no
+

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

Required:no
name : string|null

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
+For all other cases, the name corresponds to the parameter name used by the in property.

Required:yes
description : string|null

A brief description of the parameter.

This could contain examples of use.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
in : string|null

The location of the parameter.

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

Required:yes
+Possible values are "query", "header", "path" or "cookie".

Required:yes
required : bool|null

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:no
+Otherwise, the property may be included and its default value is false.

Required:no
deprecated : bool|null
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool|null

Sets the ability to pass empty-valued parameters.

@@ -1647,61 +1647,61 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : OpenApi\Attributes\Schema|null
-

The schema defining the type used for the parameter.

Required:no
+

The schema defining the type used for the parameter.

Required:no
example : mixed|null

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:no
+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:no
examples : array<Examples>

Examples of the parameter.

Each example should contain a value in the correct format as specified in the parameter encoding.
The examples object is mutually exclusive of the example object.
-Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
content : array<MediaType>|JsonContent|XmlContent|Attachable|null

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:no
+The map must only contain one entry.

Required:no
style : string|null

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:no
+Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Required:no
explode : bool|null

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:no
+For all other styles, the default value is false.

Required:no
allowReserved : bool|null

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:no
+The default value is false.

Required:no
spaceDelimited : array|null

Space separated array values.

-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
pipeDelimited : array|null

Pipe separated array values.

-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Patch](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Patch.php) @@ -1720,19 +1720,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -1741,22 +1741,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -1766,9 +1766,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -1776,22 +1776,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [PathItem](https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathItem.php) @@ -1810,45 +1810,45 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:no
+

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

Required:no
ref : string|class-string|object|null
-

No details available.

Required:no
See:Using refs
+

No details available.

Required:no
See:Reference Object
summary : string|null
-

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

Required:no
+

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

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
get : OpenApi\Attributes\Get|null
-

A definition of a GET operation on this path.

Required:no
+

A definition of a GET operation on this path.

Required:no
put : OpenApi\Attributes\Put|null
-

A definition of a PUT operation on this path.

Required:no
+

A definition of a PUT operation on this path.

Required:no
post : OpenApi\Attributes\Post|null
-

A definition of a POST operation on this path.

Required:no
+

A definition of a POST operation on this path.

Required:no
delete : OpenApi\Attributes\Delete|null
-

A definition of a DELETE operation on this path.

Required:no
+

A definition of a DELETE operation on this path.

Required:no
options : OpenApi\Attributes\Options|null
-

A definition of a OPTIONS operation on this path.

Required:no
+

A definition of a OPTIONS operation on this path.

Required:no
head : OpenApi\Attributes\Head|null
-

A definition of a HEAD operation on this path.

Required:no
+

A definition of a HEAD operation on this path.

Required:no
patch : OpenApi\Attributes\Patch|null
-

A definition of a PATCH operation on this path.

Required:no
+

A definition of a PATCH operation on this path.

Required:no
trace : OpenApi\Attributes\Trace|null
-

A definition of a TRACE operation on this path.

Required:no
+

A definition of a TRACE operation on this path.

Required:no
servers : Server[]|null
-

An alternative server array to service all operations in this path.

Required:no
+

An alternative server array to service all operations in this path.

Required:no
parameters : Parameter[]|null

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.

Required:no
+The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [PathParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathParameter.php) @@ -1867,26 +1867,26 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:no
+

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

Required:no
name : string|null

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
+For all other cases, the name corresponds to the parameter name used by the in property.

Required:yes
description : string|null

A brief description of the parameter.

This could contain examples of use.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
in : string|null
-

This takes 'path' as the default location.

Required:no
+

This takes 'path' as the default location.

Required:no
required : bool|null
-

No details available.

Required:no
+

No details available.

Required:no
deprecated : bool|null
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool|null

Sets the ability to pass empty-valued parameters.

@@ -1894,61 +1894,61 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : OpenApi\Attributes\Schema|null
-

The schema defining the type used for the parameter.

Required:no
+

The schema defining the type used for the parameter.

Required:no
example : mixed|null

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:no
+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:no
examples : array<Examples>

Examples of the parameter.

Each example should contain a value in the correct format as specified in the parameter encoding.
The examples object is mutually exclusive of the example object.
-Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
content : array<MediaType>|JsonContent|XmlContent|Attachable|null

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:no
+The map must only contain one entry.

Required:no
style : string|null

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:no
+Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Required:no
explode : bool|null

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:no
+For all other styles, the default value is false.

Required:no
allowReserved : bool|null

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:no
+The default value is false.

Required:no
spaceDelimited : array|null

Space separated array values.

-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
pipeDelimited : array|null

Pipe separated array values.

-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Post](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Post.php) @@ -1967,19 +1967,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -1988,22 +1988,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -2013,9 +2013,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -2023,22 +2023,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Property](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Property.php) @@ -2057,42 +2057,42 @@ These will be ignored but can be used for custom processing.

string|null -

The key into Schema->properties array.

Required:no
+

The key into Schema->properties array.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : string|null
-

The key into Components->schemas array.

Required:no
+

The key into Components->schemas array.

Required:no
title : string|null

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:no
+Preferably short; use description for more details.

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
maxProperties : int|null

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:no
+value of this attribute.

Required:no
minProperties : int|null

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:no
+value of this attribute.

Required:no
required : string[]

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

Required:no
+array value.

Required:no
properties : Property[]

A collection of properties to define for an object.

-Each property is represented as an instance of the Property class.

Required:no
+Each property is represented as an instance of the Property class.

Required:no
type : string|non-empty-array<string>|null

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:no
+Since OpenApi v3.1 an array of types may be used.

Required:no
format : string|null
-

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

Required:no
+

The extending format for the previously mentioned type.

Required:no
See:Data Types
items : OpenApi\Attributes\Items|null
-

Required if type is "array". Describes the type of items in the array.

Required:no
+

Required if type is "array". Describes the type of items in the array.

Required:no
collectionFormat : string|null

Determines the format of the array if type array is used.

@@ -2103,57 +2103,57 @@ Possible values are:
- 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:no
+value is csv.

Required:no
default : mixed|null
-

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

Required:no
See:JSON schema validation
+

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
+

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

Required:no
See:JSON schema validation
exclusiveMaximum : int|float|bool|null

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

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

Required:no
See:JSON schema validation
exclusiveMinimum : int|float|bool|null

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

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
+attribute.

Required:no
See:JSON schema validation
minLength : int|null

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
+attribute.

Required:no
See:JSON schema validation
maxItems : int|null

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
+this attribute.

Required:no
See:JSON schema validation
minItems : int|null

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
+of this attribute.

Required:no
See:JSON schema validation
uniqueItems : bool|null

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
+If this attribute is set to true, then all items in the array must be unique.

Required:no
See:JSON schema validation
pattern : string|null
-

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

Required:no
+

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

Required:no
enum : array<string|int|float|bool|\UnitEnum|null>|class-string|null

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
+collection.

Required:no
See:JSON schema validation
discriminator : OpenApi\Attributes\Discriminator|null

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.

Required:no
+payload description. See Composition and Inheritance for more details.

Required:no
readOnly : bool|null

Declares the property as "read only".

@@ -2162,7 +2162,7 @@ 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:no
+false.

Required:no
writeOnly : bool|null

Declares the property as "write only".

@@ -2170,46 +2170,46 @@ 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:no
+false.

Required:no
xml : OpenApi\Attributes\Xml|null

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.

Required:no
+Adds additional metadata to describe the XML representation of this property.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this schema.

Required:no
+

Additional external documentation for this schema.

Required:no
example : mixed|null

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:no
+contain the example with escaping where necessary.

Required:no
nullable : bool|null

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:no
+instead make the "type" property an array and add "null" as a possible type.

Required:no
deprecated : bool|null

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

Required:no
+Default value is false.

Required:no
allOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
anyOf : array<Schema|OA\Schema>

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

Required:no
+schema defined by this property's value.

Required:no
oneOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
-

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
+

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Put](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Put.php) @@ -2228,19 +2228,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -2249,22 +2249,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -2274,9 +2274,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -2284,22 +2284,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [QueryParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/QueryParameter.php) @@ -2318,29 +2318,29 @@ These will be ignored but can be used for custom processing.

string|null -

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

Required:no
+

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

Required:no
name : string|null

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
+For all other cases, the name corresponds to the parameter name used by the in property.

Required:yes
description : string|null

A brief description of the parameter.

This could contain examples of use.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
in : string|null
-

This takes 'query' as the default location.

Required:yes
+

This takes 'query' as the default location.

Required:yes
required : bool|null

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:no
+Otherwise, the property may be included and its default value is false.

Required:no
deprecated : bool|null
-

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

Required:no
+

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

Required:no
allowEmptyValue : bool|null

Sets the ability to pass empty-valued parameters.

@@ -2348,61 +2348,61 @@ This is valid only for query parameters and allows sending a parameter with an e
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:no
+If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : OpenApi\Attributes\Schema|null
-

The schema defining the type used for the parameter.

Required:no
+

The schema defining the type used for the parameter.

Required:no
example : mixed|null

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:no
+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:no
examples : array<Examples>

Examples of the parameter.

Each example should contain a value in the correct format as specified in the parameter encoding.
The examples object is mutually exclusive of the example object.
-Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
content : array<MediaType>|JsonContent|XmlContent|Attachable|null

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:no
+The map must only contain one entry.

Required:no
style : string|null

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:no
+Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

Required:no
explode : bool|null

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:no
+For all other styles, the default value is false.

Required:no
allowReserved : bool|null

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:no
+The default value is false.

Required:no
spaceDelimited : array|null

Space separated array values.

-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

Required:no
pipeDelimited : array|null

Pipe separated array values.

-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
+This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [RequestBody](https://github.com/zircote/swagger-php/tree/master/src/Attributes/RequestBody.php) @@ -2421,32 +2421,32 @@ These will be ignored but can be used for custom processing.

string|class-string|object|null -

The relative or absolute path to a request body.

Required:no
See:Using refs
+

The relative or absolute path to a request body.

Required:no
See:Reference Object
request : string|null
-

The key into Components->requestBodies array.

Required:no
+

The key into Components->requestBodies array.

Required:no
description : string|null

A brief description of the parameter.

This could contain examples of use.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
required : bool|null

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:no
+Otherwise, the property may be included and its default value is false.

Required:no
content : array<MediaType|JsonContent|XmlContent>|MediaType|XmlContent|Attachable|null

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/*.

Required:no
+only the most specific key is applicable. e.g. text/plain overrides text/*.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Response](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Response.php) @@ -2465,40 +2465,40 @@ These will be ignored but can be used for custom processing.

string|class-string|object|null -

The relative or absolute path to a response.

Required:no
See:Using refs
+

The relative or absolute path to a response.

Required:no
See:Reference Object
response : string|int|null

The key into Operations->responses array.

-A HTTP status code or default.

Required:no
+A HTTP status code or default.

Required:no
description : string|null

A short description of the response.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
headers : Header[]

Maps a header name to its definition.

-RFC7230 states header names are case insensitive.
+RFC7230 states header names are case-insensitive.

-If a response header is defined with the name "Content-Type", it shall be ignored.

Required:no
See:RFC7230
+If a response header is defined with the name "Content-Type", it shall be ignored.

Required:no
See:RFC7230
content : MediaType|JsonContent|XmlContent|Attachable|array<MediaType|Attachable>

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/*.

Required:no
+e.g. text/plain overrides text/*.

Required:no
links : Link[]

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.

Required:no
+Objects.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Schema](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Schema.php) @@ -2517,40 +2517,40 @@ These will be ignored but can be used for custom processing.

string|class-string|object|null -

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : string|null
-

The key into Components->schemas array.

Required:no
+

The key into Components->schemas array.

Required:no
title : string|null

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:no
+Preferably short; use description for more details.

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
maxProperties : int|null

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:no
+value of this attribute.

Required:no
minProperties : int|null

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:no
+value of this attribute.

Required:no
required : string[]

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

Required:no
+array value.

Required:no
properties : Property[]

A collection of properties to define for an object.

-Each property is represented as an instance of the Property class.

Required:no
+Each property is represented as an instance of the Property class.

Required:no
type : string|non-empty-array<string>|null

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:no
+Since OpenApi v3.1 an array of types may be used.

Required:no
format : string|null
-

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

Required:no
+

The extending format for the previously mentioned type.

Required:no
See:Data Types
items : OpenApi\Attributes\Items|null
-

Required if type is "array". Describes the type of items in the array.

Required:no
+

Required if type is "array". Describes the type of items in the array.

Required:no
collectionFormat : string|null

Determines the format of the array if type array is used.

@@ -2561,57 +2561,57 @@ Possible values are:
- 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:no
+value is csv.

Required:no
default : mixed|null
-

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

Required:no
See:JSON schema validation
+

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
+

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

Required:no
See:JSON schema validation
exclusiveMaximum : int|float|bool|null

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

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

Required:no
See:JSON schema validation
exclusiveMinimum : int|float|bool|null

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

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
+attribute.

Required:no
See:JSON schema validation
minLength : int|null

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
+attribute.

Required:no
See:JSON schema validation
maxItems : int|null

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
+this attribute.

Required:no
See:JSON schema validation
minItems : int|null

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
+of this attribute.

Required:no
See:JSON schema validation
uniqueItems : bool|null

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
+If this attribute is set to true, then all items in the array must be unique.

Required:no
See:JSON schema validation
pattern : string|null
-

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

Required:no
+

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

Required:no
enum : array<string|int|float|bool|\UnitEnum|null>|class-string|null

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
+collection.

Required:no
See:JSON schema validation
discriminator : OpenApi\Attributes\Discriminator|null

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.

Required:no
+payload description. See Composition and Inheritance for more details.

Required:no
readOnly : bool|null

Declares the property as "read only".

@@ -2620,7 +2620,7 @@ 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:no
+false.

Required:no
writeOnly : bool|null

Declares the property as "write only".

@@ -2628,54 +2628,54 @@ 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:no
+false.

Required:no
xml : OpenApi\Attributes\Xml|null

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.

Required:no
+Adds additional metadata to describe the XML representation of this property.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this schema.

Required:no
+

Additional external documentation for this schema.

Required:no
example : mixed|null

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:no
+contain the example with escaping where necessary.

Required:no
examples : array<Examples>

Examples of the schema.

Each example should contain a value in the correct format as specified in the parameter encoding.
The examples object is mutually exclusive of the example object.
-Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
nullable : bool|null

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:no
+instead make the "type" property an array and add "null" as a possible type.

Required:no
deprecated : bool|null

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

Required:no
+Default value is false.

Required:no
allOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
anyOf : array<Schema|OA\Schema>

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

Required:no
+schema defined by this property's value.

Required:no
oneOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
-

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
+

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
const : mixed|null
-

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

Required:no
+

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

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [SecurityScheme](https://github.com/zircote/swagger-php/tree/master/src/Attributes/SecurityScheme.php) @@ -2694,34 +2694,34 @@ These will be ignored but can be used for custom processing.

string|class-string|object|null -

The relative or absolute path to a security scheme.

Required:no
See:Using refs
+

The relative or absolute path to a security scheme.

Required:no
See:Reference Object
securityScheme : string|null
-

The key into OpenApi->security array.

Required:yes
+

The key into OpenApi->security array.

Required:yes
type : string|non-empty-array<string>|null
-

The type of the security scheme.

Required:yes
+

The type of the security scheme.

Required:yes
description : string|null
-

A short description for security scheme.

Required:no
+

A short description for security scheme.

Required:no
name : string|null
-

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

Required:no
+

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

Required:no
in : string|null
-

Required The location of the API key.

Required:no
+

Required The location of the API key.

Required:no
bearerFormat : string|null

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:no
+Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.

Required:no
scheme : string|null
-

The name of the HTTP Authorization scheme.

Required:no
See:RFC7235
+

The name of the HTTP Authorization scheme.

Required:no
See:RFC7235
openIdConnectUrl : string|null
-

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

Required:no
+

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

Required:no
flows : Flow[]
-

The flow used by the OAuth2 security scheme.

Required:no
+

The flow used by the OAuth2 security scheme.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Server](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Server.php) @@ -2744,22 +2744,22 @@ These will be ignored but can be used for custom processing.

Required:yes
+Variable substitutions will be made when a variable is named in {brackets}.

Required:yes
description : string|null

An optional string describing the host designated by the URL.

-CommonMark syntax may be used for rich text representation.

Required:no
+CommonMark syntax may be used for rich text representation.

Required:no
variables : ServerVariable[]

A map between a variable name and its value.

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

Required:no
+The value is used for substitution in the server's URL template.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [ServerVariable](https://github.com/zircote/swagger-php/tree/master/src/Attributes/ServerVariable.php) @@ -2778,28 +2778,28 @@ These will be ignored but can be used for custom processing.

string|null -

The key into Server->variables array.

Required:no
+

The key into Server->variables array.

Required:no
description : string|null

An optional description for the server variable.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
default : string|null

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
+Unlike the Schema Object's default, this value must be provided by the consumer.

Required:yes
enum : array<string|int|float|bool|\UnitEnum|null>|class-string|null
-

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

Required:no
+

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

Required:no
variables : array|null

A map between a variable name and its value.

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

Required:no
+The value is used for substitution in the server's URL template.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Tag](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Tag.php) @@ -2818,18 +2818,18 @@ These will be ignored but can be used for custom processing.

string|null -

The name of the tag.

Required:yes
+

The name of the tag.

Required:yes
description : string|null
-

A short description for the tag. GFM syntax can be used for rich text representation.

Required:no
+

A short description for the tag. GFM syntax can be used for rich text representation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this tag.

Required:no
+

Additional external documentation for this tag.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Trace](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Trace.php) @@ -2848,19 +2848,19 @@ These will be ignored but can be used for custom processing.

string|null -

Key in the OpenApi "Paths Object" for this operation.

Required:no
+

Key in the OpenApi "Paths Object" for this operation.

Required:no
operationId : string|null

Unique string used to identify the operation.

The id must be unique among all operations described in the API.
Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to
-follow common programming naming conventions.

Required:no
+follow common programming naming conventions.

Required:no
description : string|null

A verbose explanation of the operation behavior.

-CommonMark syntax MAY be used for rich text representation.

Required:no
+CommonMark syntax MAY be used for rich text representation.

Required:no
summary : string|null
-

A short summary of what the operation does.

Required:no
+

A short summary of what the operation does.

Required:no
security : array|null

A declaration of which security mechanisms can be used for this operation.

@@ -2869,22 +2869,22 @@ The list of values includes alternative security requirement objects that can be Only one of the security requirement objects need to be satisfied to authorize a request.

This definition overrides any declared top-level security.
-To remove a top-level security declaration, an empty array can be used.

Required:no
+To remove a top-level security declaration, an empty array can be used.

Required:no
servers : Server[]

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by
-this value.

Required:no
+this value.

Required:no
requestBody : OpenApi\Attributes\RequestBody|null

The request body applicable for this operation.

The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly
defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored
-by consumers.

Required:no
+by consumers.

Required:no
tags : string[]

A list of tags for API documentation control.

-Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
+Tags can be used for logical grouping of operations by resources or any other qualifier.

Required:no
parameters : Parameter[]

A list of parameters that are applicable for this operation.

@@ -2894,9 +2894,9 @@ 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.

Required:no
+components/parameters.

Required:no
responses : Response[]
-

The list of possible responses as they are returned from executing this operation.

Required:yes
+

The list of possible responses as they are returned from executing this operation.

Required:yes
callbacks : array|null

A map of possible out-of band callbacks related to the parent operation.

@@ -2904,22 +2904,22 @@ The key is a unique identifier for the Callback Object.

Each value in the map is a Callback Object that describes a request that may be initiated by the API provider
and the expected responses. The key value used to identify the callback object is an expression, evaluated at
-runtime, that identifies a URL to use for the callback operation.

Required:no
+runtime, that identifies a URL to use for the callback operation.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this operation.

Required:no
+

Additional external documentation for this operation.

Required:no
deprecated : bool|null

Declares this operation to be deprecated.

Consumers should refrain from usage of the declared operation.

-Default value is false.

Required:no
+Default value is false.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Webhook](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Webhook.php) @@ -2938,47 +2938,47 @@ These will be ignored but can be used for custom processing.

string|null -

Key for the webhooks map.

Required:yes
+

Key for the webhooks map.

Required:yes
path : string|null
-

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

Required:no
+

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

Required:no
ref : string|class-string|object|null
-

No details available.

Required:no
See:Using refs
+

No details available.

Required:no
See:Reference Object
summary : string|null
-

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

Required:no
+

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

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
get : OpenApi\Attributes\Get|null
-

A definition of a GET operation on this path.

Required:no
+

A definition of a GET operation on this path.

Required:no
put : OpenApi\Attributes\Put|null
-

A definition of a PUT operation on this path.

Required:no
+

A definition of a PUT operation on this path.

Required:no
post : OpenApi\Attributes\Post|null
-

A definition of a POST operation on this path.

Required:no
+

A definition of a POST operation on this path.

Required:no
delete : OpenApi\Attributes\Delete|null
-

A definition of a DELETE operation on this path.

Required:no
+

A definition of a DELETE operation on this path.

Required:no
options : OpenApi\Attributes\Options|null
-

A definition of a OPTIONS operation on this path.

Required:no
+

A definition of a OPTIONS operation on this path.

Required:no
head : OpenApi\Attributes\Head|null
-

A definition of a HEAD operation on this path.

Required:no
+

A definition of a HEAD operation on this path.

Required:no
patch : OpenApi\Attributes\Patch|null
-

A definition of a PATCH operation on this path.

Required:no
+

A definition of a PATCH operation on this path.

Required:no
trace : OpenApi\Attributes\Trace|null
-

A definition of a TRACE operation on this path.

Required:no
+

A definition of a TRACE operation on this path.

Required:no
servers : Server[]|null
-

An alternative server array to service all operations in this path.

Required:no
+

An alternative server array to service all operations in this path.

Required:no
parameters : Parameter[]|null

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.

Required:no
+The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [Xml](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Xml.php) @@ -3003,29 +3003,29 @@ When defined within the Items Object (items), it will affect the name of the ind 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.

Required:no
+If wrapped is false, it will be ignored.

Required:no
namespace : string|null
-

The URL of the namespace definition. Value SHOULD be in the form of a URL.

Required:no
+

The URL of the namespace definition. Value SHOULD be in the form of a URL.

Required:no
prefix : string|null
-

The prefix to be used for the name.

Required:no
+

The prefix to be used for the name.

Required:no
attribute : bool|null

Declares whether the property definition translates to an attribute instead of an element.

-Default value is false.

Required:no
+Default value is false.

Required:no
wrapped : bool|null

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

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

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
### [XmlContent](https://github.com/zircote/swagger-php/tree/master/src/Attributes/XmlContent.php) @@ -3044,42 +3044,42 @@ These will be ignored but can be used for custom processing.

Required:no
+Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.

Required:no
ref : string|class-string|object|null
-

The relative or absolute path to the endpoint.

Required:no
See:Using refs
+

The relative or absolute path to the endpoint.

Required:no
See:Reference Object
schema : string|null
-

The key into Components->schemas array.

Required:no
+

The key into Components->schemas array.

Required:no
title : string|null

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:no
+Preferably short; use description for more details.

Required:no
description : string|null
-

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

Required:no
+

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

Required:no
maxProperties : int|null

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:no
+value of this attribute.

Required:no
minProperties : int|null

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:no
+value of this attribute.

Required:no
required : string[]

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

Required:no
+array value.

Required:no
properties : Property[]

A collection of properties to define for an object.

-Each property is represented as an instance of the Property class.

Required:no
+Each property is represented as an instance of the Property class.

Required:no
type : string|non-empty-array<string>|null

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:no
+Since OpenApi v3.1 an array of types may be used.

Required:no
format : string|null
-

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

Required:no
+

The extending format for the previously mentioned type.

Required:no
See:Data Types
items : OpenApi\Attributes\Items|null
-

Required if type is "array". Describes the type of items in the array.

Required:no
+

Required if type is "array". Describes the type of items in the array.

Required:no
collectionFormat : string|null

Determines the format of the array if type array is used.

@@ -3090,57 +3090,57 @@ Possible values are:
- 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:no
+value is csv.

Required:no
default : mixed|null
-

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

Required:no
See:JSON schema validation
+

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
+

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

Required:no
See:JSON schema validation
exclusiveMaximum : int|float|bool|null

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

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

Required:no
See:JSON schema validation
exclusiveMinimum : int|float|bool|null

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

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
+attribute.

Required:no
See:JSON schema validation
minLength : int|null

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
+attribute.

Required:no
See:JSON schema validation
maxItems : int|null

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
+this attribute.

Required:no
See:JSON schema validation
minItems : int|null

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
+of this attribute.

Required:no
See:JSON schema validation
uniqueItems : bool|null

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
+If this attribute is set to true, then all items in the array must be unique.

Required:no
See:JSON schema validation
pattern : string|null
-

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

Required:no
+

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

Required:no
enum : array<string|int|float|bool|\UnitEnum|null>|class-string|null

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
+collection.

Required:no
See:JSON schema validation
discriminator : OpenApi\Attributes\Discriminator|null

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.

Required:no
+payload description. See Composition and Inheritance for more details.

Required:no
readOnly : bool|null

Declares the property as "read only".

@@ -3149,7 +3149,7 @@ 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:no
+false.

Required:no
writeOnly : bool|null

Declares the property as "write only".

@@ -3157,45 +3157,45 @@ 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:no
+false.

Required:no
xml : OpenApi\Attributes\Xml|null

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.

Required:no
+Adds additional metadata to describe the XML representation of this property.

Required:no
externalDocs : OpenApi\Attributes\ExternalDocumentation|null
-

Additional external documentation for this schema.

Required:no
+

Additional external documentation for this schema.

Required:no
example : mixed|null

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:no
+contain the example with escaping where necessary.

Required:no
nullable : bool|null

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:no
+instead make the "type" property an array and add "null" as a possible type.

Required:no
deprecated : bool|null

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

Required:no
+Default value is false.

Required:no
allOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
anyOf : array<Schema|OA\Schema>

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

Required:no
+schema defined by this property's value.

Required:no
oneOf : array<Schema|OA\Schema>

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

Required:no
+defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
-

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
+

http://json-schema.org/latest/json-schema-validation.html#anchor64.

Required:no
x : array<string,mixed>|null

While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
-The keys inside the array will be prefixed with `x-`.

Required:no
+The keys inside the array will be prefixed with `x-`.

Required:no
attachables : Attachable[]|null

Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.

Required:no
+These will be ignored but can be used for custom processing.

Required:no
diff --git a/src/Annotations/Components.php b/src/Annotations/Components.php index 0b01cae00..26ccae144 100644 --- a/src/Annotations/Components.php +++ b/src/Annotations/Components.php @@ -15,7 +15,7 @@ * 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. * - * @see [OAI Components Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object) + * @see [Components Object](https://spec.openapis.org/oas/v3.1.1.html#components-object) * * @Annotation */ diff --git a/src/Annotations/Contact.php b/src/Annotations/Contact.php index 1075627a3..ecc2ced58 100644 --- a/src/Annotations/Contact.php +++ b/src/Annotations/Contact.php @@ -11,7 +11,7 @@ /** * Contact information for the exposed API. * - * @see [OAI Contact Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object) + * @see [Contact Object](https://spec.openapis.org/oas/v3.1.1.html#components-object) * * @Annotation */ diff --git a/src/Annotations/Discriminator.php b/src/Annotations/Discriminator.php index 90e99032a..bbfa69cb9 100644 --- a/src/Annotations/Discriminator.php +++ b/src/Annotations/Discriminator.php @@ -15,7 +15,7 @@ * 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. * - * @see [OAI Discriminator Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminatorObject) + * @see [Discriminator Object](https://spec.openapis.org/oas/v3.1.1.html#discriminator-object) * @see [JSON Schema](http://json-schema.org/) * * @Annotation diff --git a/src/Annotations/Examples.php b/src/Annotations/Examples.php index 3532bb1e5..f6d74a062 100644 --- a/src/Annotations/Examples.php +++ b/src/Annotations/Examples.php @@ -16,7 +16,7 @@ class Examples extends AbstractAnnotation /** * The relative or absolute path to an example. * - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ diff --git a/src/Annotations/ExternalDocumentation.php b/src/Annotations/ExternalDocumentation.php index 81bff45c4..350e9a02f 100644 --- a/src/Annotations/ExternalDocumentation.php +++ b/src/Annotations/ExternalDocumentation.php @@ -11,7 +11,7 @@ /** * Allows referencing an external resource for extended documentation. * - * @see [OAI External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#external-documentation-object) + * @see [External Documentation Object](https://spec.openapis.org/oas/v3.1.1.html#external-documentation-object) * * @Annotation */ diff --git a/src/Annotations/Flow.php b/src/Annotations/Flow.php index 540920626..594c04b77 100644 --- a/src/Annotations/Flow.php +++ b/src/Annotations/Flow.php @@ -9,9 +9,9 @@ use OpenApi\Generator; /** - * Configuration details for a supported OAuth Flow. + * Configuration details for a supported OAuth flow. * - * @see [OAI OAuth Flow Object](https://swagger.io/specification/#oauthFlowObject) + * @see [OAuth Flow Object](https://spec.openapis.org/oas/v3.1.1.html#oauth-flow-object) * * @Annotation */ diff --git a/src/Annotations/Header.php b/src/Annotations/Header.php index 8d6b64d10..08cc47c15 100644 --- a/src/Annotations/Header.php +++ b/src/Annotations/Header.php @@ -8,7 +8,7 @@ use OpenApi\Generator; /** - * @see [OAI Header Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject). + * @see [Header Object](https://spec.openapis.org/oas/v3.1.1.html#header-object) * * @Annotation */ @@ -17,7 +17,7 @@ class Header extends AbstractAnnotation /** * The relative or absolute path to the endpoint. * - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ diff --git a/src/Annotations/Info.php b/src/Annotations/Info.php index db535b3cc..f697eb1b0 100644 --- a/src/Annotations/Info.php +++ b/src/Annotations/Info.php @@ -13,7 +13,7 @@ * * The metadata may be used by the clients if needed and may be presented in editing or documentation generation tools for convenience. * - * @see [OAI Info Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object) + * @see [Info Object](https://spec.openapis.org/oas/v3.1.1.html#info-object) * * @Annotation */ diff --git a/src/Annotations/License.php b/src/Annotations/License.php index ac04bc68d..1047bec64 100644 --- a/src/Annotations/License.php +++ b/src/Annotations/License.php @@ -11,7 +11,7 @@ /** * License information for the exposed API. * - * @see [OAI License Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object) + * @see [License Object](https://spec.openapis.org/oas/v3.1.1.html#license-object) * * @Annotation */ diff --git a/src/Annotations/Link.php b/src/Annotations/Link.php index 30be649f5..67199b27e 100644 --- a/src/Annotations/Link.php +++ b/src/Annotations/Link.php @@ -20,14 +20,14 @@ * 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. * - * @see [OAI Link Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object) + * @see [Link Object](https://spec.openapis.org/oas/v3.1.1.html#link-object) * * @Annotation */ class Link extends AbstractAnnotation { /** - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ diff --git a/src/Annotations/MediaType.php b/src/Annotations/MediaType.php index be104325e..dc46797e1 100644 --- a/src/Annotations/MediaType.php +++ b/src/Annotations/MediaType.php @@ -11,7 +11,7 @@ /** * Each Media Type object provides schema and examples for the media type identified by its key. * - * @see [OAI Media Type Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object) + * @see [Media Type Object](https://spec.openapis.org/oas/v3.1.1.html#media-type-object) * * @Annotation */ diff --git a/src/Annotations/OpenApi.php b/src/Annotations/OpenApi.php index 5351a6e87..31383362d 100644 --- a/src/Annotations/OpenApi.php +++ b/src/Annotations/OpenApi.php @@ -14,7 +14,7 @@ /** * This is the root document object for the API specification. * - * @see [OAI OpenApi Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#openapi-object) + * @see [OpenApi Object](https://spec.openapis.org/oas/v3.1.1.html#openapi-object) * * @Annotation */ diff --git a/src/Annotations/Operation.php b/src/Annotations/Operation.php index bc089dc17..7c008834f 100644 --- a/src/Annotations/Operation.php +++ b/src/Annotations/Operation.php @@ -14,7 +14,7 @@ * * Describes a single API operation on a path. * - * @see [OAI Operation Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object) + * @see [Operation Object](https://spec.openapis.org/oas/v3.1.1.html#operation-object) * * @Annotation */ diff --git a/src/Annotations/Parameter.php b/src/Annotations/Parameter.php index 417d5c9ed..ef05aabb3 100644 --- a/src/Annotations/Parameter.php +++ b/src/Annotations/Parameter.php @@ -13,7 +13,7 @@ * * A unique parameter is defined by a combination of a name and location. * - * @see [OAA Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object) + * @see [Parameter Object](https://spec.openapis.org/oas/v3.1.1.html#parameter-object) * * @Annotation */ @@ -22,7 +22,7 @@ class Parameter extends AbstractAnnotation /** * The relative or absolute path to the endpoint. * - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ diff --git a/src/Annotations/PathItem.php b/src/Annotations/PathItem.php index c99efd5ca..6666bdb3d 100644 --- a/src/Annotations/PathItem.php +++ b/src/Annotations/PathItem.php @@ -14,14 +14,14 @@ * 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. * - * @see [OAI Path Item Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object) + * @see [Path Item Object](https://spec.openapis.org/oas/v3.1.1.html#path-item-object) * * @Annotation */ class PathItem extends AbstractAnnotation { /** - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ diff --git a/src/Annotations/RequestBody.php b/src/Annotations/RequestBody.php index cf954d5d6..6c55bb304 100644 --- a/src/Annotations/RequestBody.php +++ b/src/Annotations/RequestBody.php @@ -13,7 +13,7 @@ /** * Describes a single request body. * - * @see [OAI Request Body Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#requestBodyObject) + * @see [Request Body Object](https://spec.openapis.org/oas/v3.1.1.html#request-body-object) * * @Annotation */ @@ -22,7 +22,7 @@ class RequestBody extends AbstractAnnotation /** * The relative or absolute path to a request body. * - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ diff --git a/src/Annotations/Response.php b/src/Annotations/Response.php index db3abf14f..1ffe9698d 100644 --- a/src/Annotations/Response.php +++ b/src/Annotations/Response.php @@ -12,7 +12,7 @@ * Describes a single response from an API Operation, including design-time, * static links to operations based on the response. * - * @see [OAI Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object) + * @see [Response Object](https://spec.openapis.org/oas/v3.1.1.html#response-object) * * @Annotation */ @@ -21,7 +21,7 @@ class Response extends AbstractAnnotation /** * The relative or absolute path to a response. * - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ @@ -48,7 +48,7 @@ class Response extends AbstractAnnotation /** * Maps a header name to its definition. * - * RFC7230 states header names are case insensitive. + * RFC7230 states header names are case-insensitive. * * If a response header is defined with the name "Content-Type", it shall be ignored. * diff --git a/src/Annotations/Schema.php b/src/Annotations/Schema.php index 12390159b..505a539f1 100644 --- a/src/Annotations/Schema.php +++ b/src/Annotations/Schema.php @@ -16,7 +16,7 @@ * 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. * - * @see [OAI Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject) + * @see [Schema Object](https://spec.openapis.org/oas/v3.1.1.html#schema-object) * @see [JSON Schema](http://json-schema.org/) * * @Annotation @@ -26,7 +26,7 @@ class Schema extends AbstractAnnotation /** * The relative or absolute path to the endpoint. * - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ @@ -102,7 +102,9 @@ class Schema extends AbstractAnnotation public $type = Generator::UNDEFINED; /** - * The extending format for the previously mentioned type. See Data Type Formats for further details. + * The extending format for the previously mentioned type. + * + * @see [Data Types](https://spec.openapis.org/oas/v3.1.1.html#data-types) * * @var string */ diff --git a/src/Annotations/SecurityScheme.php b/src/Annotations/SecurityScheme.php index 631fcec8b..37ef7effb 100644 --- a/src/Annotations/SecurityScheme.php +++ b/src/Annotations/SecurityScheme.php @@ -9,7 +9,7 @@ use OpenApi\Generator; /** - * @see [OAI Security Scheme Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject). + * @see [Security Scheme Object](https://spec.openapis.org/oas/v3.1.1.html#security-scheme-object-0) * * @Annotation */ @@ -18,7 +18,7 @@ class SecurityScheme extends AbstractAnnotation /** * The relative or absolute path to a security scheme. * - * @see [Using refs](https://swagger.io/docs/specification/using-ref/) + * @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object) * * @var string|class-string|object */ diff --git a/src/Annotations/Server.php b/src/Annotations/Server.php index df0cb0d5e..9a807e5aa 100644 --- a/src/Annotations/Server.php +++ b/src/Annotations/Server.php @@ -11,7 +11,7 @@ /** * An object representing a server. * - * @see [OAI Server Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object) + * @see [Server Object](https://spec.openapis.org/oas/v3.1.1.html#server-object) * * @Annotation */ diff --git a/src/Annotations/ServerVariable.php b/src/Annotations/ServerVariable.php index 7b43f97e6..d92a57eb4 100644 --- a/src/Annotations/ServerVariable.php +++ b/src/Annotations/ServerVariable.php @@ -11,7 +11,7 @@ /** * An object representing a server variable for server URL template substitution. * - * @see [OAI Server Variable Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object) + * @see [Server Variable Object](https://spec.openapis.org/oas/v3.1.1.html#server-variable-object) * * @Annotation */ diff --git a/src/Annotations/Tag.php b/src/Annotations/Tag.php index 670ac879e..94d6f23e2 100644 --- a/src/Annotations/Tag.php +++ b/src/Annotations/Tag.php @@ -9,7 +9,7 @@ use OpenApi\Generator; /** - * @see [OAI Tag Object]( https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#tagObject). + * @see [Tag Object](https://spec.openapis.org/oas/v3.1.1.html#tag-object) * * @Annotation */ diff --git a/src/Annotations/Xml.php b/src/Annotations/Xml.php index 6afa4cc99..2ff6a4ef8 100644 --- a/src/Annotations/Xml.php +++ b/src/Annotations/Xml.php @@ -9,7 +9,7 @@ use OpenApi\Generator; /** - * @see [OAI XML Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#xmlObject). + * @see [XML Object](https://spec.openapis.org/oas/v3.1.1.html#xml-object) * * @Annotation */ diff --git a/src/Serializer.php b/src/Serializer.php index ca02e1c46..8e53718ee 100644 --- a/src/Serializer.php +++ b/src/Serializer.php @@ -11,8 +11,6 @@ /** * Allows to serialize/de-serialize annotations from/to JSON. - * - * @see https://github.com/zircote/swagger-php */ class Serializer { diff --git a/tools/src/Docs/RefGenerator.php b/tools/src/Docs/RefGenerator.php index 0d8bca8dc..4f1006b8f 100644 --- a/tools/src/Docs/RefGenerator.php +++ b/tools/src/Docs/RefGenerator.php @@ -182,7 +182,7 @@ protected function propertyDetails(array $propertyDocumentation): void { echo '

' . nl2br($propertyDocumentation['content'] ?: self::NO_DETAILS_AVAILABLE) . '

'; - echo ''; + echo '
'; echo ''; if ($propertyDocumentation['see']) { @@ -197,7 +197,7 @@ protected function propertyDetails(array $propertyDocumentation): void } } - echo '
Required:' . ($propertyDocumentation['required'] ? 'yes' : 'no') . '
'; + echo '
'; } /**