From 34ab00f53a120c3641b6832b964110aea737126f Mon Sep 17 00:00:00 2001 From: DerManoMann Date: Fri, 19 Apr 2024 11:03:16 +1200 Subject: [PATCH] Refresh docs --- docs/reference/annotations.md | 49 ++++--- docs/reference/attributes.md | 253 ++++++++++++++++++++-------------- docs/reference/processors.md | 4 +- 3 files changed, 182 insertions(+), 124 deletions(-) diff --git a/docs/reference/annotations.md b/docs/reference/annotations.md index e5803528..3c3435da 100644 --- a/docs/reference/annotations.md +++ b/docs/reference/annotations.md @@ -155,7 +155,7 @@ On top of this subset, there are extensions provided by this specification to al #### Allowed in --- -Components, Parameter, PathParameter, MediaType, JsonContent, XmlContent +Components, Schema, Parameter, PathParameter, MediaType, JsonContent, XmlContent #### Nested elements --- @@ -490,7 +490,7 @@ The key is the parameter name to be used, whereas the value can be a constant or be evaluated and passed to the linked operation.
The parameter name can be qualified using the parameter location [{in}.]{name} for operations
that use the same parameter name in different locations (e.g. path.id).

-
requestBody : mixed
+
requestBody

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

description : string

A description of the link.
@@ -519,7 +519,7 @@ Each Media Type object provides schema and examples for the media type identifie

mediaType : string

The key into Operation->content array.

-
example : mixed
+
example

Example of the media type.

The example object should be in the correct format as specified by the media type.
@@ -661,7 +661,7 @@ For all other styles, the default value is false.

This property only applies to parameters with an in value of query.

The default value is false.

-
example : mixed
+
example

Example of the media type.

The example should match the specified schema and encoding properties if present.
@@ -867,7 +867,7 @@ Describes a single request body.

ref : string|class-string|object

The relative or absolute path to a request body.

See: Using refs

request : string
-

Request body model name.

+

The key into Components->requestBodies array.

description : string

A brief description of the parameter.

@@ -932,7 +932,7 @@ On top of this subset, there are extensions provided by this specification to al #### Nested elements --- -Discriminator, Items, Property, ExternalDocumentation, Xml, AdditionalProperties, Attachable +Discriminator, Items, Property, ExternalDocumentation, Examples, Xml, AdditionalProperties, Attachable #### Properties --- @@ -949,10 +949,12 @@ Preferably short; use description for more details.

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

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.

+An object instance is valid against this property if its number of properties is less than, or equal to, the
+value of this attribute.

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.

+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 : string[]

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

@@ -972,10 +974,10 @@ Possible values are:
- ssv: space separated values foo bar.
- tsv: tab separated values foo\tbar.
- pipes: pipe separated values foo|bar.
-- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
-This is valid only for parameters of type query or formData.
-Default value is csv.

-
default : mixed
+- multi: corresponds to multiple parameter instances instead of multiple values for a single instance
+foo=bar&foo=baz. This is valid only for parameters of type query or formData. Default
+value is csv.

+
default

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

See: JSON schema validation

maximum : int|float

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

See: JSON schema validation

@@ -992,29 +994,34 @@ When set to true, the minimum value is excluded, and when false or not specified
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.

See: JSON schema validation

+A string instance is valid against this property if its length is less than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+A string instance is valid against this property if its length is greater than, or equal to, the value of this
+attribute.

See: JSON schema validation

pattern : string

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

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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is less than, or equal to, the value of
+this attribute.

See: 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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is greater than, or equal to, the value
+of this attribute.

See: 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.

See: JSON schema validation

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

See: JSON schema validation

+A property instance is valid against this attribute if its value is one of the values specified in this
+collection.

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.

@@ -1035,7 +1042,7 @@ Therefore, it may be sent as part of a request but should not be sent as part of 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.

-
example : mixed
+
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
@@ -1070,7 +1077,7 @@ defined by this property's value.

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

propertyNames

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

-
const : mixed
+
const

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

@@ -1168,7 +1175,7 @@ An object representing a server variable for server URL template substitution.
serverVariable : string

The key into Server->variables array.

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

default : string

The default value to use for substitution, and to send, if an alternate value is not supplied.
diff --git a/docs/reference/attributes.md b/docs/reference/attributes.md index d2d3172f..534412bd 100644 --- a/docs/reference/attributes.md +++ b/docs/reference/attributes.md @@ -33,10 +33,12 @@ Preferably short; use description for more details.

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

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.

+An object instance is valid against this property if its number of properties is less than, or equal to, the
+value of this attribute.

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.

+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 : string[]

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

@@ -62,9 +64,9 @@ Possible values are:
- ssv: space separated values foo bar.
- tsv: tab separated values foo\tbar.
- pipes: pipe separated values foo|bar.
-- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
-This is valid only for parameters of type query or formData.
-Default value is csv.

+- multi: corresponds to multiple parameter instances instead of multiple values for a single instance
+foo=bar&foo=baz. This is valid only for parameters of type query or formData. Default
+value is csv.

default : mixed|null

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

See: JSON schema validation

maximum : int|float
@@ -82,29 +84,34 @@ When set to true, the minimum value is excluded, and when false or not specified
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.

See: JSON schema validation

+A string instance is valid against this property if its length is less than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+A string instance is valid against this property if its length is greater than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is less than, or equal to, the value of
+this attribute.

See: 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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is greater than, or equal to, the value
+of this attribute.

See: 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.

See: JSON schema validation

pattern : string|null

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

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

See: JSON schema validation

+A property instance is valid against this attribute if its value is one of the values specified in this
+collection.

See: JSON schema validation

discriminator : OpenApi\Attributes\Discriminator|null

Adds support for polymorphism.

@@ -206,7 +213,7 @@ These will be ignored but can be used for custom processing.

Reusable Parameters.

requestBodies : RequestBody[]|null

Reusable Request Bodies.

-
examples : Examples[]|null
+
examples : array<Examples>|null

Reusable Examples.

headers : Header[]|null

Reusable Headers.

@@ -313,8 +320,8 @@ The example should match the specified schema and encoding properties if present The example object is mutually exclusive of the examples object.
Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.
To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

-
examples : array<string,Examples>
-

Examples of the media type.
+

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.
@@ -387,7 +394,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -482,7 +489,7 @@ These will be ignored but can be used for custom processing.

#### Allowed in --- -Components, Parameter, PathParameter, MediaType, JsonContent, XmlContent +Components, Schema, Parameter, PathParameter, MediaType, JsonContent, XmlContent #### Nested elements --- @@ -628,7 +635,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -718,7 +725,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -884,8 +891,8 @@ The example should match the specified schema and encoding properties if present The example object is mutually exclusive of the examples object.
Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.
To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

-
examples : array<string,Examples>
-

Examples of the media type.
+

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.
@@ -996,10 +1003,12 @@ Preferably short; use description for more details.

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

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.

+An object instance is valid against this property if its number of properties is less than, or equal to, the
+value of this attribute.

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.

+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 : string[]

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

@@ -1025,9 +1034,9 @@ Possible values are:
- ssv: space separated values foo bar.
- tsv: tab separated values foo\tbar.
- pipes: pipe separated values foo|bar.
-- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
-This is valid only for parameters of type query or formData.
-Default value is csv.

+- multi: corresponds to multiple parameter instances instead of multiple values for a single instance
+foo=bar&foo=baz. This is valid only for parameters of type query or formData. Default
+value is csv.

default : mixed|null

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

See: JSON schema validation

maximum : int|float
@@ -1045,29 +1054,34 @@ When set to true, the minimum value is excluded, and when false or not specified
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.

See: JSON schema validation

+A string instance is valid against this property if its length is less than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+A string instance is valid against this property if its length is greater than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is less than, or equal to, the value of
+this attribute.

See: 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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is greater than, or equal to, the value
+of this attribute.

See: 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.

See: JSON schema validation

pattern : string|null

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

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

See: JSON schema validation

+A property instance is valid against this attribute if its value is one of the values specified in this
+collection.

See: JSON schema validation

discriminator : OpenApi\Attributes\Discriminator|null

Adds support for polymorphism.

@@ -1142,11 +1156,12 @@ These will be ignored but can be used for custom processing.

#### Parameters ---
-
examples : array<string,Examples>
-

An associative array of Examples attributes.
+

examples : array<Examples>
+

Examples of the schema.

-The keys represent the name of the example and the values are instances of the Examples attribute.
-Each example is used to show how the content of the request or response should look like.

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

ref : string|class-string|object|null

The relative or absolute path to the endpoint.

See: Using refs

schema : string|null
@@ -1159,10 +1174,12 @@ Preferably short; use description for more details.

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

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.

+An object instance is valid against this property if its number of properties is less than, or equal to, the
+value of this attribute.

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.

+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 : string[]

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

@@ -1188,9 +1205,9 @@ Possible values are:
- ssv: space separated values foo bar.
- tsv: tab separated values foo\tbar.
- pipes: pipe separated values foo|bar.
-- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
-This is valid only for parameters of type query or formData.
-Default value is csv.

+- multi: corresponds to multiple parameter instances instead of multiple values for a single instance
+foo=bar&foo=baz. This is valid only for parameters of type query or formData. Default
+value is csv.

default : mixed|null

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

See: JSON schema validation

maximum : int|float
@@ -1208,29 +1225,34 @@ When set to true, the minimum value is excluded, and when false or not specified
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.

See: JSON schema validation

+A string instance is valid against this property if its length is less than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+A string instance is valid against this property if its length is greater than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is less than, or equal to, the value of
+this attribute.

See: 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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is greater than, or equal to, the value
+of this attribute.

See: 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.

See: JSON schema validation

pattern : string|null

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

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

See: JSON schema validation

+A property instance is valid against this attribute if its value is one of the values specified in this
+collection.

See: JSON schema validation

discriminator : OpenApi\Attributes\Discriminator|null

Adds support for polymorphism.

@@ -1407,14 +1429,12 @@ The example object is mutually exclusive of the examples object.

Furthermore, if referencing a schema which contains an example,
the example value shall override the example provided by the schema.

-
examples : array<string,Examples>
+
examples : array<Examples>

Examples of the media type.

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

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

encoding : array<string,mixed>

A map between a property name and its encoding information.

@@ -1516,7 +1536,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -1637,8 +1657,8 @@ The example should match the specified schema and encoding properties if present The example object is mutually exclusive of the examples object.
Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.
To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

-
examples : array<string,Examples>
-

Examples of the media type.
+

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.
@@ -1711,7 +1731,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -1884,8 +1904,8 @@ The example should match the specified schema and encoding properties if present The example object is mutually exclusive of the examples object.
Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.
To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

-
examples : array<string,Examples>
-

Examples of the media type.
+

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.
@@ -1958,7 +1978,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -2048,10 +2068,12 @@ Preferably short; use description for more details.

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

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.

+An object instance is valid against this property if its number of properties is less than, or equal to, the
+value of this attribute.

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.

+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 : string[]

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

@@ -2077,9 +2099,9 @@ Possible values are:
- ssv: space separated values foo bar.
- tsv: tab separated values foo\tbar.
- pipes: pipe separated values foo|bar.
-- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
-This is valid only for parameters of type query or formData.
-Default value is csv.

+- multi: corresponds to multiple parameter instances instead of multiple values for a single instance
+foo=bar&foo=baz. This is valid only for parameters of type query or formData. Default
+value is csv.

default : mixed|null

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

See: JSON schema validation

maximum : int|float
@@ -2097,29 +2119,34 @@ When set to true, the minimum value is excluded, and when false or not specified
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.

See: JSON schema validation

+A string instance is valid against this property if its length is less than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+A string instance is valid against this property if its length is greater than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is less than, or equal to, the value of
+this attribute.

See: 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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is greater than, or equal to, the value
+of this attribute.

See: 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.

See: JSON schema validation

pattern : string|null

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

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

See: JSON schema validation

+A property instance is valid against this attribute if its value is one of the values specified in this
+collection.

See: JSON schema validation

discriminator : OpenApi\Attributes\Discriminator|null

Adds support for polymorphism.

@@ -2212,7 +2239,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -2331,8 +2358,8 @@ The example should match the specified schema and encoding properties if present The example object is mutually exclusive of the examples object.
Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.
To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

-
examples : array<string,Examples>
-

Examples of the media type.
+

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.
@@ -2394,7 +2421,7 @@ These will be ignored but can be used for custom processing.

ref : string|class-string|object|null

The relative or absolute path to a request body.

See: Using refs

request : string|null
-

Request body model name.

+

The key into Components->requestBodies array.

description : string|null

A brief description of the parameter.

@@ -2482,7 +2509,7 @@ These will be ignored but can be used for custom processing.

#### Nested elements --- -Discriminator, Items, Property, ExternalDocumentation, Xml, AdditionalProperties, Attachable +Discriminator, Items, Property, ExternalDocumentation, Examples, Xml, AdditionalProperties, Attachable #### Parameters --- @@ -2499,10 +2526,12 @@ Preferably short; use description for more details.

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

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.

+An object instance is valid against this property if its number of properties is less than, or equal to, the
+value of this attribute.

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.

+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 : string[]

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

@@ -2528,9 +2557,9 @@ Possible values are:
- ssv: space separated values foo bar.
- tsv: tab separated values foo\tbar.
- pipes: pipe separated values foo|bar.
-- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
-This is valid only for parameters of type query or formData.
-Default value is csv.

+- multi: corresponds to multiple parameter instances instead of multiple values for a single instance
+foo=bar&foo=baz. This is valid only for parameters of type query or formData. Default
+value is csv.

default : mixed|null

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

See: JSON schema validation

maximum : int|float
@@ -2548,29 +2577,34 @@ When set to true, the minimum value is excluded, and when false or not specified
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.

See: JSON schema validation

+A string instance is valid against this property if its length is less than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+A string instance is valid against this property if its length is greater than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is less than, or equal to, the value of
+this attribute.

See: 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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is greater than, or equal to, the value
+of this attribute.

See: 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.

See: JSON schema validation

pattern : string|null

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

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

See: JSON schema validation

+A property instance is valid against this attribute if its value is one of the values specified in this
+collection.

See: JSON schema validation

discriminator : OpenApi\Attributes\Discriminator|null

Adds support for polymorphism.

@@ -2605,6 +2639,12 @@ Adds additional metadata to describe the XML representation of this property.

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.

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

nullable : bool|null

Allows sending a null value for the defined schema.
Default value is false.
@@ -2625,7 +2665,7 @@ schema defined by this property's value.

defined by this property's value.

additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null

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

-
const : mixed
+
const : mixed|null

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

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.
@@ -2745,7 +2785,7 @@ CommonMark syntax MAY be used for rich text representation.

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.

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string|null
+
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.

variables : array|null

A map between a variable name and its value.
@@ -2819,7 +2859,7 @@ follow common programming naming conventions.

CommonMark syntax MAY be used for rich text representation.

summary : string|null

A short summary of what the operation does.

-
security : array
+
security : array|null

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

The list of values includes alternative security requirement objects that can be used.
@@ -2997,8 +3037,12 @@ These will be ignored but can be used for custom processing.

#### Parameters ---
-
examples : array<string,Examples>
-

No details available.

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

ref : string|class-string|object|null

The relative or absolute path to the endpoint.

See: Using refs

schema : string|null
@@ -3011,10 +3055,12 @@ Preferably short; use description for more details.

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

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.

+An object instance is valid against this property if its number of properties is less than, or equal to, the
+value of this attribute.

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.

+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 : string[]

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

@@ -3040,9 +3086,9 @@ Possible values are:
- ssv: space separated values foo bar.
- tsv: tab separated values foo\tbar.
- pipes: pipe separated values foo|bar.
-- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz.
-This is valid only for parameters of type query or formData.
-Default value is csv.

+- multi: corresponds to multiple parameter instances instead of multiple values for a single instance
+foo=bar&foo=baz. This is valid only for parameters of type query or formData. Default
+value is csv.

default : mixed|null

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

See: JSON schema validation

maximum : int|float
@@ -3060,29 +3106,34 @@ When set to true, the minimum value is excluded, and when false or not specified
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.

See: JSON schema validation

+A string instance is valid against this property if its length is less than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+A string instance is valid against this property if its length is greater than, or equal to, the value of this
+attribute.

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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is less than, or equal to, the value of
+this attribute.

See: 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.

See: JSON schema validation

+An array instance is valid against this property if its number of items is greater than, or equal to, the value
+of this attribute.

See: 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.

See: JSON schema validation

pattern : string|null

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

-
enum : string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string
+
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.

See: JSON schema validation

+A property instance is valid against this attribute if its value is one of the values specified in this
+collection.

See: JSON schema validation

discriminator : OpenApi\Attributes\Discriminator|null

Adds support for polymorphism.

diff --git a/docs/reference/processors.md b/docs/reference/processors.md index ae32253c..1059565b 100644 --- a/docs/reference/processors.md +++ b/docs/reference/processors.md @@ -58,7 +58,7 @@ Build the openapi->paths using the detected `@OA\PathItem` and `@OA\Operation` ( ### Config settings

augmentParameters.augmentOperationParameters : bool
-

If set to true try to find operation parameter descriptions in the operation docblock.

+

No details available.

@@ -77,7 +77,7 @@ Generate the OperationId based on the context of the OpenApi annotation. ### Config settings
operationId.hash : bool
-

If set to true generate ids (md5) instead of clear text operation ids.

+

No details available.