From 34ab00f53a120c3641b6832b964110aea737126f Mon Sep 17 00:00:00 2001
From: DerManoMann
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).
A literal value or {expression} to use as a request body when calling the target operation.
A description of the link.
@@ -519,7 +519,7 @@ Each Media Type object provides schema and examples for the media type identifie
The key into Operation->content array.
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.
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.
The relative or absolute path to a request body.
See: Using refs
Request body model name.
The key into Components->requestBodies array.
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.
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.
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 property set contains all elements in this property's
array value.
query
or formData
.query
or formData
. DefaultSets a default value to the parameter. The type of the value depends on the defined type.
The maximum value allowed for a numeric property. This value must be a number.
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.
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.
A string instance is considered valid if the regular expression matches the instance successfully.
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.
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.
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.
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.
A numeric instance is valid against "multipleOf" if the result of the division of the instance by this
property's value is an integer.
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.
http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.22.
http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.
The key into Server->variables array.
An enumeration of values to be used if the substitution options are from a limited set.
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.
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.
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 property set contains all elements in this property's
array value.
query
or formData
.query
or formData
. DefaultSets a default value to the parameter. The type of the value depends on the defined type.
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.
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.
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.
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.
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.
A string instance is considered valid if the regular expression matches the instance successfully.
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.
Adds support for polymorphism.
@@ -206,7 +213,7 @@ These will be ignored but can be used for custom processing.
Reusable Parameters.
Reusable Request Bodies.
Reusable Examples.
Reusable Headers.
Examples of the media type.
+
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.
A short summary of what the operation does.
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.
A short summary of what the operation does.
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.
A short summary of what the operation does.
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 of the media type.
+
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.
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.
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 property set contains all elements in this property's
array value.
query
or formData
.query
or formData
. DefaultSets a default value to the parameter. The type of the value depends on the defined type.
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.
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.
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.
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.
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.
A string instance is considered valid if the regular expression matches the instance successfully.
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.
Adds support for polymorphism.
@@ -1142,11 +1156,12 @@ These will be ignored but can be used for custom processing.
An associative array of Examples attributes.
+
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.
The relative or absolute path to the endpoint.
See: Using refs
description
for more details.
A description will provide explanation about the purpose of the instance described by this schema.
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.
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 property set contains all elements in this property's
array value.
query
or formData
.query
or formData
. DefaultSets a default value to the parameter. The type of the value depends on the defined type.
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.
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.
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.
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.
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.
A string instance is considered valid if the regular expression matches the instance successfully.
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.
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 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.
A map between a property name and its encoding information.
@@ -1516,7 +1536,7 @@ follow common programming naming conventions.
A short summary of what the operation does.
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 of the media type.
+
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.
A short summary of what the operation does.
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 of the media type.
+
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.
A short summary of what the operation does.
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.
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.
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 property set contains all elements in this property's
array value.
query
or formData
.query
or formData
. DefaultSets a default value to the parameter. The type of the value depends on the defined type.
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.
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.
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.
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.
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.
A string instance is considered valid if the regular expression matches the instance successfully.
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.
Adds support for polymorphism.
@@ -2212,7 +2239,7 @@ follow common programming naming conventions.
A short summary of what the operation does.
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 of the media type.
+
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.
The relative or absolute path to a request body.
See: Using refs
Request body model name.
The key into Components->requestBodies array.
A brief description of the parameter.
@@ -2482,7 +2509,7 @@ These will be ignored but can be used for custom processing.
description
for more details.
A description will provide explanation about the purpose of the instance described by this schema.
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.
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 property set contains all elements in this property's
array value.
query
or formData
.query
or formData
. DefaultSets a default value to the parameter. The type of the value depends on the defined type.
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.
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.
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.
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.
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.
A string instance is considered valid if the regular expression matches the instance successfully.
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.
Adds support for polymorphism.
@@ -2605,6 +2639,12 @@ Adds additional metadata to describe the XML representation of this property.
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.
Allows sending a null value for the defined schema.
Default value is false.
@@ -2625,7 +2665,7 @@ schema defined by this property's value.
http://json-schema.org/latest/json-schema-validation.html#anchor64.
http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.
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.
An enumeration of values to be used if the substitution options are from a limited set.
A map between a variable name and its value.
@@ -2819,7 +2859,7 @@ follow common programming naming conventions.
A short summary of what the operation does.
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.
No details available.
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.
The relative or absolute path to the endpoint.
See: Using refs
description
for more details.
A description will provide explanation about the purpose of the instance described by this schema.
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.
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 property set contains all elements in this property's
array value.
query
or formData
.query
or formData
. DefaultSets a default value to the parameter. The type of the value depends on the defined type.
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.
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.
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.
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.
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.
A string instance is considered valid if the regular expression matches the instance successfully.
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.
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
If set to true
try to find operation parameter descriptions in the operation docblock.
No details available.
If set to true
generate ids (md5) instead of clear text operation ids.
No details available.