Reusable Callbacks.
Reusable Callbacks.
| Required: | no |
The identifying name of the contact person/organization.
The identifying name of the contact person/organization.
| Required: | no |
The URL pointing to the contact information.
The URL pointing to the contact information.
| Required: | no |
The email address of the contact person/organization.
The email address of the contact person/organization.
| Required: | no |
This takes 'cookie' as the default location.
This takes 'cookie' as the default location.
| Required: | yes |
No details available.
No details available.
| Required: | no |
The name of the property in the payload that will hold the discriminator value.
The name of the property in the payload that will hold the discriminator value.
| Required: | yes |
An object to hold mappings between payload values and schema names or references.
An object to hold mappings between payload values and schema names or references.
| Required: | no |
The relative or absolute path to an example.
See: Using refs
The relative or absolute path to an example.
| Required: | no |
| See: | Using refs |
The key into `#/components/examples`.
The key into `#/components/examples`.
| Required: | no |
Short description for the example.
Short description for the example.
| Required: | yes |
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 |
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 |
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 |
A short description of the target documentation. GFM syntax can be used for rich text representation.
A short description of the target documentation. GFM syntax can be used for rich text representation.
| Required: | no |
The URL for the target documentation.
The URL for the target documentation.
| Required: | yes |
The authorization url to be used for this flow.
-This must be in the form of an url.
| Required: | no |
The token URL to be used for this flow.
-This must be in the form of an url.
| Required: | no |
The URL to be used for obtaining refresh tokens.
-This must be in the form of an url.
| Required: | no |
Flow name.
-One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].
| Required: | yes |
The available scopes for the OAuth2 security scheme.
-A map between the scope name and a short description for it.
| Required: | yes |
No details available.
No details available.
| Required: | no |
No details available.
No details available.
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
No details available.
No details available.
| Required: | yes |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
No details available.
No details available.
| Required: | no |
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
| Required: | no |
Sets the ability to pass empty-valued parameters.
@@ -334,7 +334,7 @@ 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 |
This takes 'header' as the default location.
This takes 'header' as the default location.
| Required: | yes |
The title of the application.
The title of the application.
| Required: | yes |
A short description of the application.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
An URL to the Terms of Service for the API.
-Must be in the format of an url.
| Required: | no |
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
| Required: | yes |
The license name used for the API.
The license name used for the API.
| Required: | yes |
An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.
An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.
| Required: | no |
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 |
No details available.
See: Using refs
No details available.
| Required: | no |
| See: | Using refs |
The key into MediaType->links array.
The key into MediaType->links array.
| Required: | no |
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 |
The name of an existing, resolvable OA operation, as defined with a unique operationId.
-This field is mutually exclusive of the operationRef field.
operationRef field.| Required: | no |
A map representing parameters to pass to an operation as specified with operationId or identified via
operationRef.
@@ -491,13 +491,13 @@ 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 |
A literal value or {expression} to use as a request body when calling the target operation.
A literal value or {expression} to use as a request body when calling the target operation.
| Required: | no |
A description of the link.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
The key into Operation->content array.
The key into Operation->content array.
| Required: | no |
Example of the media type.
@@ -528,14 +528,14 @@ 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 |
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 |
| Required: | yes |
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 |
No details available.
No details available.
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components::parameters or PathItem::parameters array.
The key into Components::parameters or PathItem::parameters array.
| Required: | no |
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 |
The location of the parameter.
-Possible values are "query", "header", "path" or "cookie".
| Required: | yes |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
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 |
Specifies that a parameter is deprecated and should be transitioned out of usage.
Specifies that a parameter is deprecated and should be transitioned out of usage.
| Required: | no |
Sets the ability to pass empty-valued parameters.
@@ -645,58 +645,58 @@ 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 |
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 |
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 |
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 |
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 |
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 |
Path-style parameters defined by RFC6570.
See: RFC6570
Path-style parameters defined by RFC6570.
| Required: | no |
| See: | RFC6570 |
Label style parameters defined by RFC6570.
See: RFC6570
Label style parameters defined by RFC6570.
| Required: | no |
| See: | RFC6570 |
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.
See: RFC6570
| Required: | no |
| See: | RFC6570 |
Simple style parameters defined by RFC6570.
-This option replaces collectionFormat with a csv value from OpenAPI 2.0.
See: RFC6570
| Required: | no |
| See: | RFC6570 |
Space separated array values.
-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
| Required: | no |
Pipe separated array values.
-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
| Required: | no |
Provides a simple way of rendering nested objects using form parameters.
Provides a simple way of rendering nested objects using form parameters.
| Required: | no |
No details available.
No details available.
| Required: | no |
No details available.
See: Using refs
No details available.
| Required: | no |
| See: | Using refs |
An optional, string summary, intended to apply to all operations in this path.
An optional, string summary, intended to apply to all operations in this path.
| Required: | no |
An optional, string description, intended to apply to all operations in this path.
An optional, string description, intended to apply to all operations in this path.
| Required: | no |
Key for the Path Object (OpenApi->paths array).
Key for the Path Object (OpenApi->paths array).
| Required: | no |
This takes 'path' as the default location.
This takes 'path' as the default location.
| Required: | no |
No details available.
No details available.
| Required: | no |
No details available.
No details available.
| Required: | no |
The key into Schema->properties array.
The key into Schema->properties array.
| Required: | no |
No details available.
No details available.
| Required: | no |
This takes 'query' as the default location.
This takes 'query' as the default location.
| Required: | yes |
The relative or absolute path to a request body.
See: Using refs
The relative or absolute path to a request body.
| Required: | no |
| See: | Using refs |
The key into Components->requestBodies array.
The key into Components->requestBodies array.
| Required: | no |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
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 |
The relative or absolute path to a response.
See: Using refs
The relative or absolute path to a response.
| Required: | no |
| See: | Using refs |
The key into Operations->responses array.
-A HTTP status code or default.
default.| Required: | no |
A short description of the response.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components->schemas array.
The key into Components->schemas array.
| Required: | no |
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.
description for more details.| Required: | no |
A description will provide explanation about the purpose of the instance described by this schema.
A description will provide explanation about the purpose of the instance described by this schema.
| Required: | no |
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 |
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 |
An object instance is valid against this property if its property set contains all elements in this property's
-array value.
| Required: | no |
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 |
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 Type Formats for further details.
| Required: | no |
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 |
Sets a default value to the parameter. The type of the value depends on the defined type.
Sets a default value to the parameter. The type of the value depends on the defined type.
| Required: | no |
| See: | JSON schema validation |
The maximum value allowed for a numeric property. This value must be a number.
The maximum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
The minimum value allowed for a numeric property. This value must be a number.
The minimum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
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 |
A string instance is considered valid if the regular expression matches the instance successfully.
A string instance is considered valid if the regular expression matches the instance successfully.
| Required: | no |
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 |
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 |
A boolean value indicating whether all items in an array property must be unique.
-If this attribute is set to true, then all items in the array must be unique.
| Required: | no |
| See: | JSON schema validation |
A collection of allowable values for a property.
A property instance is valid against this attribute if its value is one of the values specified in this
-collection.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
Declares the property as "write only".
@@ -1043,44 +1043,44 @@ 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 |
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 |
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 |
Specifies that a schema is deprecated and should be transitioned out of usage.
-Default value is false.
| Required: | no |
An instance validates successfully against this property if it validates successfully against all schemas
-defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against at least one
-schema defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against exactly one schema
-defined by this property's value.
| Required: | no |
http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.29.
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.10.
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.14.
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.19.
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.21.
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.22.
http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.22.
| Required: | no |
http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.
http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.
| Required: | no |
The relative or absolute path to a security scheme.
See: Using refs
The relative or absolute path to a security scheme.
| Required: | no |
| See: | Using refs |
The key into OpenApi->security array.
The key into OpenApi->security array.
| Required: | yes |
The type of the security scheme.
The type of the security scheme.
| Required: | yes |
A short description for security scheme.
A short description for security scheme.
| Required: | no |
The name of the header or query parameter to be used.
The name of the header or query parameter to be used.
| Required: | no |
Required The location of the API key.
Required The location of the API key.
| Required: | no |
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 |
The name of the HTTP Authorization scheme.
See: RFC7235
The name of the HTTP Authorization scheme.
| Required: | no |
| See: | RFC7235 |
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
| Required: | no |
| Required: | yes |
An optional string describing the host designated by the URL.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
The key into Server->variables array.
The key into Server->variables array.
| Required: | no |
An enumeration of values to be used if the substitution options are from a limited set.
An enumeration of values to be used if the substitution options are from a limited set.
| Required: | no |
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 |
A map between a variable name and its value.
-The value is used for substitution in the server's URL template.
| Required: | no |
An optional description for the server variable.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
The name of the tag.
The name of the tag.
| Required: | yes |
A short description for the tag. GFM syntax can be used for rich text representation.
A short description for the tag. GFM syntax can be used for rich text representation.
| Required: | no |
No details available.
No details available.
| Required: | no |
Key for the webhooks map.
Key for the webhooks map.
| Required: | yes |
true.false, it will be ignored.
+If wrapped is false, it will be ignored.| Required: | no |
The URL of the namespace definition. Value SHOULD be in the form of a URL.
The URL of the namespace definition. Value SHOULD be in the form of a URL.
| Required: | no |
The prefix to be used for the name.
The prefix to be used for the name.
| Required: | no |
Declares whether the property definition translates to an attribute instead of an element.
-Default value is false.
false.| Required: | no |
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 |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components->schemas array.
The key into Components->schemas array.
| Required: | no |
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.
description for more details.| Required: | no |
A description will provide explanation about the purpose of the instance described by this schema.
A description will provide explanation about the purpose of the instance described by this schema.
| Required: | no |
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 |
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 |
An object instance is valid against this property if its property set contains all elements in this property's
-array value.
| Required: | no |
A collection of properties to define for an object.
-Each property is represented as an instance of the Property class.
| Required: | no |
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 |
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 Type Formats for further details.
| Required: | no |
Required if type is "array". Describes the type of items in the array.
Required if type is "array". Describes the type of items in the array.
| Required: | no |
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 |
Sets a default value to the parameter. The type of the value depends on the defined type.
Sets a default value to the parameter. The type of the value depends on the defined type.
| Required: | no |
| See: | JSON schema validation |
The maximum value allowed for a numeric property. This value must be a number.
The maximum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
The minimum value allowed for a numeric property. This value must be a number.
The minimum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
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 |
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 |
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 |
A boolean value indicating whether all items in an array property must be unique.
-If this attribute is set to true, then all items in the array must be unique.
| Required: | no |
| See: | JSON schema validation |
A string instance is considered valid if the regular expression matches the instance successfully.
A string instance is considered valid if the regular expression matches the instance successfully.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
Additional external documentation for this schema.
Additional external documentation for this schema.
| Required: | no |
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 |
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 |
Specifies that a schema is deprecated and should be transitioned out of usage.
-Default value is false.
| Required: | no |
An instance validates successfully against this property if it validates successfully against all schemas
-defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against at least one
-schema defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against exactly one schema
-defined by this property's value.
| Required: | no |
http://json-schema.org/latest/json-schema-validation.html#anchor64.
http://json-schema.org/latest/json-schema-validation.html#anchor64.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
No details available.
No details available.
| Required: | no |
Reusable Schemas.
Reusable Schemas.
| Required: | no |
Reusable Responses.
Reusable Responses.
| Required: | no |
Reusable Parameters.
Reusable Parameters.
| Required: | no |
Reusable Request Bodies.
Reusable Request Bodies.
| Required: | no |
Reusable Examples.
Reusable Examples.
| Required: | no |
Reusable Headers.
Reusable Headers.
| Required: | no |
Reusable Security Schemes.
Reusable Security Schemes.
| Required: | no |
Reusable Links.
Reusable Links.
| Required: | no |
Reusable Callbacks.
Reusable Callbacks.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The identifying name of the contact person/organization.
The identifying name of the contact person/organization.
| Required: | no |
The URL pointing to the contact information.
The URL pointing to the contact information.
| Required: | no |
The email address of the contact person/organization.
The email address of the contact person/organization.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Components::parameters or PathItem::parameters array.
The key into Components::parameters or PathItem::parameters array.
| Required: | no |
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 |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
This takes 'cookie' as the default location.
This takes 'cookie' as the default location.
| Required: | yes |
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 |
Specifies that a parameter is deprecated and should be transitioned out of usage.
Specifies that a parameter is deprecated and should be transitioned out of usage.
| Required: | no |
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 |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The schema defining the type used for the parameter.
The schema defining the type used for the parameter.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
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 |
Space separated array values.
-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
| Required: | no |
Pipe separated array values.
-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The name of the property in the payload that will hold the discriminator value.
The name of the property in the payload that will hold the discriminator value.
| Required: | yes |
An object to hold mappings between payload values and schema names or references.
An object to hold mappings between payload values and schema names or references.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into `#/components/examples`.
The key into `#/components/examples`.
| Required: | no |
Short description for the example.
Short description for the example.
| Required: | yes |
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 |
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 |
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 relative or absolute path to an example.
See: Using refs
The relative or absolute path to an example.
| Required: | no |
| See: | Using refs |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
A short description of the target documentation. GFM syntax can be used for rich text representation.
A short description of the target documentation. GFM syntax can be used for rich text representation.
| Required: | no |
The URL for the target documentation.
The URL for the target documentation.
| Required: | yes |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The authorization url to be used for this flow.
-This must be in the form of an url.
| Required: | no |
The token URL to be used for this flow.
-This must be in the form of an url.
| Required: | no |
The URL to be used for obtaining refresh tokens.
-This must be in the form of an url.
| Required: | no |
Flow name.
-One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].
| Required: | yes |
The available scopes for the OAuth2 security scheme.
-A map between the scope name and a short description for it.
| Required: | yes |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
No details available.
No details available.
| Required: | yes |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
No details available.
No details available.
| Required: | no |
Schema object.
Schema object.
| Required: | yes |
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
| Required: | no |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Components::parameters or PathItem::parameters array.
The key into Components::parameters or PathItem::parameters array.
| Required: | no |
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 |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
This takes 'header' as the default location.
This takes 'header' as the default location.
| Required: | yes |
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 |
Specifies that a parameter is deprecated and should be transitioned out of usage.
Specifies that a parameter is deprecated and should be transitioned out of usage.
| Required: | no |
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 |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The schema defining the type used for the parameter.
The schema defining the type used for the parameter.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
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 |
Space separated array values.
-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
| Required: | no |
Pipe separated array values.
-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
| Required: | yes |
A short description of the application.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
The title of the application.
The title of the application.
| Required: | yes |
An URL to the Terms of Service for the API.
-Must be in the format of an url.
| Required: | no |
The contact information for the exposed API.
The contact information for the exposed API.
| Required: | no |
The license information for the exposed API.
The license information for the exposed API.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components->schemas array.
The key into Components->schemas array.
| Required: | no |
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.
description for more details.| Required: | no |
A description will provide explanation about the purpose of the instance described by this schema.
A description will provide explanation about the purpose of the instance described by this schema.
| Required: | no |
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 |
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 |
An object instance is valid against this property if its property set contains all elements in this property's
-array value.
| Required: | no |
A collection of properties to define for an object.
-Each property is represented as an instance of the Property class.
| Required: | no |
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 |
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 Type Formats for further details.
| Required: | no |
Required if type is "array". Describes the type of items in the array.
Required if type is "array". Describes the type of items in the array.
| Required: | no |
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 |
Sets a default value to the parameter. The type of the value depends on the defined type.
Sets a default value to the parameter. The type of the value depends on the defined type.
| Required: | no |
| See: | JSON schema validation |
The maximum value allowed for a numeric property. This value must be a number.
The maximum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
The minimum value allowed for a numeric property. This value must be a number.
The minimum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
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 |
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 |
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 |
A boolean value indicating whether all items in an array property must be unique.
-If this attribute is set to true, then all items in the array must be unique.
| Required: | no |
| See: | JSON schema validation |
A string instance is considered valid if the regular expression matches the instance successfully.
A string instance is considered valid if the regular expression matches the instance successfully.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
Additional external documentation for this schema.
Additional external documentation for this schema.
| Required: | no |
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 |
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 |
Specifies that a schema is deprecated and should be transitioned out of usage.
-Default value is false.
| Required: | no |
An instance validates successfully against this property if it validates successfully against all schemas
-defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against at least one
-schema defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against exactly one schema
-defined by this property's value.
| Required: | no |
http://json-schema.org/latest/json-schema-validation.html#anchor64.
http://json-schema.org/latest/json-schema-validation.html#anchor64.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components->schemas array.
The key into Components->schemas array.
| Required: | no |
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.
description for more details.| Required: | no |
A description will provide explanation about the purpose of the instance described by this schema.
A description will provide explanation about the purpose of the instance described by this schema.
| Required: | no |
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 |
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 |
An object instance is valid against this property if its property set contains all elements in this property's
-array value.
| Required: | no |
A collection of properties to define for an object.
-Each property is represented as an instance of the Property class.
| Required: | no |
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 |
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 Type Formats for further details.
| Required: | no |
Required if type is "array". Describes the type of items in the array.
Required if type is "array". Describes the type of items in the array.
| Required: | no |
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 |
Sets a default value to the parameter. The type of the value depends on the defined type.
Sets a default value to the parameter. The type of the value depends on the defined type.
| Required: | no |
| See: | JSON schema validation |
The maximum value allowed for a numeric property. This value must be a number.
The maximum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
The minimum value allowed for a numeric property. This value must be a number.
The minimum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
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 |
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 |
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 |
A boolean value indicating whether all items in an array property must be unique.
-If this attribute is set to true, then all items in the array must be unique.
| Required: | no |
| See: | JSON schema validation |
A string instance is considered valid if the regular expression matches the instance successfully.
A string instance is considered valid if the regular expression matches the instance successfully.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
Additional external documentation for this schema.
Additional external documentation for this schema.
| Required: | no |
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 |
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 |
Specifies that a schema is deprecated and should be transitioned out of usage.
-Default value is false.
| Required: | no |
An instance validates successfully against this property if it validates successfully against all schemas
-defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against at least one
-schema defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against exactly one schema
-defined by this property's value.
| Required: | no |
http://json-schema.org/latest/json-schema-validation.html#anchor64.
http://json-schema.org/latest/json-schema-validation.html#anchor64.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The license name used for the API.
The license name used for the API.
| Required: | yes |
An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.
An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.
| Required: | no |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into MediaType->links array.
The key into MediaType->links array.
| Required: | no |
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 |
No details available.
See: Using refs
No details available.
| Required: | no |
| See: | Using refs |
The name of an existing, resolvable OA operation, as defined with a unique operationId.
-This field is mutually exclusive of the operationRef field.
operationRef field.| Required: | no |
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 |
A literal value or {expression} to use as a request body when calling the target operation.
A literal value or {expression} to use as a request body when calling the target operation.
| Required: | no |
A description of the link.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
A server object to be used by the target operation.
A server object to be used by the target operation.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Operation->content array.
The key into Operation->content array.
| Required: | no |
The schema defining the type used for the request body.
The schema defining the type used for the request body.
| Required: | no |
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 |
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 |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
| Required: | yes |
Provides metadata about the API. The metadata may be used by tooling as required.
Provides metadata about the API. The metadata may be used by tooling as required.
| Required: | yes |
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 |
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 |
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 |
Additional external documentation.
Additional external documentation.
| Required: | no |
The available paths and operations for the API.
The available paths and operations for the API.
| Required: | no |
An element to hold various components for the specification.
An element to hold various components for the specification.
| Required: | no |
The available webhooks for the API.
The available webhooks for the API.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Components::parameters or PathItem::parameters array.
The key into Components::parameters or PathItem::parameters array.
| Required: | no |
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 |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
The location of the parameter.
-Possible values are "query", "header", "path" or "cookie".
| Required: | yes |
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 |
Specifies that a parameter is deprecated and should be transitioned out of usage.
Specifies that a parameter is deprecated and should be transitioned out of usage.
| Required: | no |
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 |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The schema defining the type used for the parameter.
The schema defining the type used for the parameter.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
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 |
Space separated array values.
-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
| Required: | no |
Pipe separated array values.
-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key for the Path Object (OpenApi->paths array).
Key for the Path Object (OpenApi->paths array).
| Required: | no |
No details available.
See: Using refs
No details available.
| Required: | no |
| See: | Using refs |
An optional, string summary, intended to apply to all operations in this path.
An optional, string summary, intended to apply to all operations in this path.
| Required: | no |
An optional, string description, intended to apply to all operations in this path.
An optional, string description, intended to apply to all operations in this path.
| Required: | no |
A definition of a GET operation on this path.
A definition of a GET operation on this path.
| Required: | no |
A definition of a PUT operation on this path.
A definition of a PUT operation on this path.
| Required: | no |
A definition of a POST operation on this path.
A definition of a POST operation on this path.
| Required: | no |
A definition of a DELETE operation on this path.
A definition of a DELETE operation on this path.
| Required: | no |
A definition of a OPTIONS operation on this path.
A definition of a OPTIONS operation on this path.
| Required: | no |
A definition of a HEAD operation on this path.
A definition of a HEAD operation on this path.
| Required: | no |
A definition of a PATCH operation on this path.
A definition of a PATCH operation on this path.
| Required: | no |
A definition of a TRACE operation on this path.
A definition of a TRACE operation on this path.
| Required: | no |
An alternative server array to service all operations in this path.
An alternative server array to service all operations in this path.
| Required: | no |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Components::parameters or PathItem::parameters array.
The key into Components::parameters or PathItem::parameters array.
| Required: | no |
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 |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
This takes 'path' as the default location.
This takes 'path' as the default location.
| Required: | no |
No details available.
No details available.
| Required: | no |
Specifies that a parameter is deprecated and should be transitioned out of usage.
Specifies that a parameter is deprecated and should be transitioned out of usage.
| Required: | no |
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 |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The schema defining the type used for the parameter.
The schema defining the type used for the parameter.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
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 |
Space separated array values.
-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
| Required: | no |
Pipe separated array values.
-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Schema->properties array.
The key into Schema->properties array.
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components->schemas array.
The key into Components->schemas array.
| Required: | no |
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.
description for more details.| Required: | no |
A description will provide explanation about the purpose of the instance described by this schema.
A description will provide explanation about the purpose of the instance described by this schema.
| Required: | no |
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 |
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 |
An object instance is valid against this property if its property set contains all elements in this property's
-array value.
| Required: | no |
A collection of properties to define for an object.
-Each property is represented as an instance of the Property class.
| Required: | no |
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 |
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 Type Formats for further details.
| Required: | no |
Required if type is "array". Describes the type of items in the array.
Required if type is "array". Describes the type of items in the array.
| Required: | no |
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 |
Sets a default value to the parameter. The type of the value depends on the defined type.
Sets a default value to the parameter. The type of the value depends on the defined type.
| Required: | no |
| See: | JSON schema validation |
The maximum value allowed for a numeric property. This value must be a number.
The maximum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
The minimum value allowed for a numeric property. This value must be a number.
The minimum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
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 |
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 |
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 |
A boolean value indicating whether all items in an array property must be unique.
-If this attribute is set to true, then all items in the array must be unique.
| Required: | no |
| See: | JSON schema validation |
A string instance is considered valid if the regular expression matches the instance successfully.
A string instance is considered valid if the regular expression matches the instance successfully.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
Additional external documentation for this schema.
Additional external documentation for this schema.
| Required: | no |
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 |
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 |
Specifies that a schema is deprecated and should be transitioned out of usage.
-Default value is false.
| Required: | no |
An instance validates successfully against this property if it validates successfully against all schemas
-defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against at least one
-schema defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against exactly one schema
-defined by this property's value.
| Required: | no |
http://json-schema.org/latest/json-schema-validation.html#anchor64.
http://json-schema.org/latest/json-schema-validation.html#anchor64.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Components::parameters or PathItem::parameters array.
The key into Components::parameters or PathItem::parameters array.
| Required: | no |
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 |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
This takes 'query' as the default location.
This takes 'query' as the default location.
| Required: | yes |
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 |
Specifies that a parameter is deprecated and should be transitioned out of usage.
Specifies that a parameter is deprecated and should be transitioned out of usage.
| Required: | no |
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 |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The schema defining the type used for the parameter.
The schema defining the type used for the parameter.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
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 |
Space separated array values.
-This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
| Required: | no |
Pipe separated array values.
-This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The relative or absolute path to a request body.
See: Using refs
The relative or absolute path to a request body.
| Required: | no |
| See: | Using refs |
The key into Components->requestBodies array.
The key into Components->requestBodies array.
| Required: | no |
A brief description of the parameter.
This could contain examples of use.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
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 |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The relative or absolute path to a response.
See: Using refs
The relative or absolute path to a response.
| Required: | no |
| See: | Using refs |
The key into Operations->responses array.
-A HTTP status code or default.
default.| Required: | no |
A short description of the response.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
Maps a header name to its definition.
RFC7230 states header names are case insensitive.
-If a response header is defined with the name "Content-Type", it shall be ignored.
See: RFC7230
| Required: | no |
| See: | RFC7230 |
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/*.
text/plain overrides text/*.| Required: | no |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components->schemas array.
The key into Components->schemas array.
| Required: | no |
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.
description for more details.| Required: | no |
A description will provide explanation about the purpose of the instance described by this schema.
A description will provide explanation about the purpose of the instance described by this schema.
| Required: | no |
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 |
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 |
An object instance is valid against this property if its property set contains all elements in this property's
-array value.
| Required: | no |
A collection of properties to define for an object.
-Each property is represented as an instance of the Property class.
| Required: | no |
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 |
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 Type Formats for further details.
| Required: | no |
Required if type is "array". Describes the type of items in the array.
Required if type is "array". Describes the type of items in the array.
| Required: | no |
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 |
Sets a default value to the parameter. The type of the value depends on the defined type.
Sets a default value to the parameter. The type of the value depends on the defined type.
| Required: | no |
| See: | JSON schema validation |
The maximum value allowed for a numeric property. This value must be a number.
The maximum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
The minimum value allowed for a numeric property. This value must be a number.
The minimum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
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 |
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 |
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 |
A boolean value indicating whether all items in an array property must be unique.
-If this attribute is set to true, then all items in the array must be unique.
| Required: | no |
| See: | JSON schema validation |
A string instance is considered valid if the regular expression matches the instance successfully.
A string instance is considered valid if the regular expression matches the instance successfully.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
Additional external documentation for this schema.
Additional external documentation for this schema.
| Required: | no |
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 |
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 |
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 |
Specifies that a schema is deprecated and should be transitioned out of usage.
-Default value is false.
| Required: | no |
An instance validates successfully against this property if it validates successfully against all schemas
-defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against at least one
-schema defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against exactly one schema
-defined by this property's value.
| Required: | no |
http://json-schema.org/latest/json-schema-validation.html#anchor64.
http://json-schema.org/latest/json-schema-validation.html#anchor64.
| Required: | no |
http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.
http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The relative or absolute path to a security scheme.
See: Using refs
The relative or absolute path to a security scheme.
| Required: | no |
| See: | Using refs |
The key into OpenApi->security array.
The key into OpenApi->security array.
| Required: | yes |
The type of the security scheme.
The type of the security scheme.
| Required: | yes |
A short description for security scheme.
A short description for security scheme.
| Required: | no |
The name of the header or query parameter to be used.
The name of the header or query parameter to be used.
| Required: | no |
Required The location of the API key.
Required The location of the API key.
| Required: | no |
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 |
The name of the HTTP Authorization scheme.
See: RFC7235
The name of the HTTP Authorization scheme.
| Required: | no |
| See: | RFC7235 |
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
| Required: | no |
The flow used by the OAuth2 security scheme.
The flow used by the OAuth2 security scheme.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
| Required: | yes |
An optional string describing the host designated by the URL.
-CommonMark syntax may be used for rich text representation.
| Required: | no |
A map between a variable name and its value.
-The value is used for substitution in the server's URL template.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The key into Server->variables array.
The key into Server->variables array.
| Required: | no |
An optional description for the server variable.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
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 |
An enumeration of values to be used if the substitution options are from a limited set.
An enumeration of values to be used if the substitution options are from a limited set.
| Required: | no |
A map between a variable name and its value.
-The value is used for substitution in the server's URL template.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
The name of the tag.
The name of the tag.
| Required: | yes |
A short description for the tag. GFM syntax can be used for rich text representation.
A short description for the tag. GFM syntax can be used for rich text representation.
| Required: | no |
Additional external documentation for this tag.
Additional external documentation for this tag.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key in the OpenApi "Paths Object" for this operation.
Key in the OpenApi "Paths Object" for this operation.
| Required: | no |
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 |
A verbose explanation of the operation behavior.
-CommonMark syntax MAY be used for rich text representation.
| Required: | no |
A short summary of what the operation does.
A short summary of what the operation does.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
The list of possible responses as they are returned from executing this operation.
The list of possible responses as they are returned from executing this operation.
| Required: | yes |
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 |
Additional external documentation for this operation.
Additional external documentation for this operation.
| Required: | no |
Declares this operation to be deprecated.
Consumers should refrain from usage of the declared operation.
-Default value is false.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
Key for the webhooks map.
Key for the webhooks map.
| Required: | yes |
Key for the Path Object (OpenApi->paths array).
Key for the Path Object (OpenApi->paths array).
| Required: | no |
No details available.
See: Using refs
No details available.
| Required: | no |
| See: | Using refs |
An optional, string summary, intended to apply to all operations in this path.
An optional, string summary, intended to apply to all operations in this path.
| Required: | no |
An optional, string description, intended to apply to all operations in this path.
An optional, string description, intended to apply to all operations in this path.
| Required: | no |
A definition of a GET operation on this path.
A definition of a GET operation on this path.
| Required: | no |
A definition of a PUT operation on this path.
A definition of a PUT operation on this path.
| Required: | no |
A definition of a POST operation on this path.
A definition of a POST operation on this path.
| Required: | no |
A definition of a DELETE operation on this path.
A definition of a DELETE operation on this path.
| Required: | no |
A definition of a OPTIONS operation on this path.
A definition of a OPTIONS operation on this path.
| Required: | no |
A definition of a HEAD operation on this path.
A definition of a HEAD operation on this path.
| Required: | no |
A definition of a PATCH operation on this path.
A definition of a PATCH operation on this path.
| Required: | no |
A definition of a TRACE operation on this path.
A definition of a TRACE operation on this path.
| Required: | no |
An alternative server array to service all operations in this path.
An alternative server array to service all operations in this path.
| Required: | no |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
true.false, it will be ignored.
+If wrapped is false, it will be ignored.| Required: | no |
The URL of the namespace definition. Value SHOULD be in the form of a URL.
The URL of the namespace definition. Value SHOULD be in the form of a URL.
| Required: | no |
The prefix to be used for the name.
The prefix to be used for the name.
| Required: | no |
Declares whether the property definition translates to an attribute instead of an element.
-Default value is false.
false.| Required: | no |
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 |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
| Required: | no |
The relative or absolute path to the endpoint.
See: Using refs
The relative or absolute path to the endpoint.
| Required: | no |
| See: | Using refs |
The key into Components->schemas array.
The key into Components->schemas array.
| Required: | no |
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.
description for more details.| Required: | no |
A description will provide explanation about the purpose of the instance described by this schema.
A description will provide explanation about the purpose of the instance described by this schema.
| Required: | no |
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 |
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 |
An object instance is valid against this property if its property set contains all elements in this property's
-array value.
| Required: | no |
A collection of properties to define for an object.
-Each property is represented as an instance of the Property class.
| Required: | no |
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 |
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 Type Formats for further details.
| Required: | no |
Required if type is "array". Describes the type of items in the array.
Required if type is "array". Describes the type of items in the array.
| Required: | no |
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 |
Sets a default value to the parameter. The type of the value depends on the defined type.
Sets a default value to the parameter. The type of the value depends on the defined type.
| Required: | no |
| See: | JSON schema validation |
The maximum value allowed for a numeric property. This value must be a number.
The maximum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
The minimum value allowed for a numeric property. This value must be a number.
The minimum value allowed for a numeric property. This value must be a number.
| Required: | no |
| See: | JSON schema validation |
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 |
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 |
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 |
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 |
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 |
A boolean value indicating whether all items in an array property must be unique.
-If this attribute is set to true, then all items in the array must be unique.
| Required: | no |
| See: | JSON schema validation |
A string instance is considered valid if the regular expression matches the instance successfully.
A string instance is considered valid if the regular expression matches the instance successfully.
| Required: | no |
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 |
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 |
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 |
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 |
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 |
Additional external documentation for this schema.
Additional external documentation for this schema.
| Required: | no |
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 |
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 |
Specifies that a schema is deprecated and should be transitioned out of usage.
-Default value is false.
| Required: | no |
An instance validates successfully against this property if it validates successfully against all schemas
-defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against at least one
-schema defined by this property's value.
| Required: | no |
An instance validates successfully against this property if it validates successfully against exactly one schema
-defined by this property's value.
| Required: | no |
http://json-schema.org/latest/json-schema-validation.html#anchor64.
http://json-schema.org/latest/json-schema-validation.html#anchor64.
| Required: | no |
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 |
Arbitrary attachables for this annotation.
-These will be ignored but can be used for custom processing.
| Required: | no |
tags list.
### [CleanUnmerged](https://github.com/zircote/swagger-php/tree/master/src/Processors/CleanUnmerged.php)
@@ -151,3 +148,6 @@ Tracks the use of all Components and removed unused schemas.
+### [AugmentTags](https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentTags.php)
+
+Ensures that all tags used on operations also exist in the global tags list.
diff --git a/src/Annotations/PathParameter.php b/src/Annotations/PathParameter.php
index e8d15737..642fad4b 100644
--- a/src/Annotations/PathParameter.php
+++ b/src/Annotations/PathParameter.php
@@ -25,4 +25,9 @@ class PathParameter extends Parameter
* @inheritdoc
*/
public $required = true;
+
+ /**
+ * @inheritdoc
+ */
+ public static $_required = ['name'];
}
diff --git a/tools/src/Docs/RefGenerator.php b/tools/src/Docs/RefGenerator.php
index 99578e26..0d8bca8d 100644
--- a/tools/src/Docs/RefGenerator.php
+++ b/tools/src/Docs/RefGenerator.php
@@ -163,18 +163,28 @@ public function formatAnnotationsDetails(string $name, string $fqdn, string $fil
protected function getPropertyDocumentation(string $fqdn, string $name): array
{
+ /** @var class-string' . nl2br($propertyDocumentation['content'] ?: self::NO_DETAILS_AVAILABLE) . '
'; + + echo '| Required: | ' . ($propertyDocumentation['required'] ? 'yes' : 'no') . ' |
| See: | ' . implode(', ', $links) . ' |